/snapmuse-api

Primary LanguageJavaScript

snapmuse-api

About

This repository contains the API code for the MVP "Snapmuse" (placeholder title) application.

This was delivered as part of the Project module for the BSc. Hons in Contemporary Software development.

The corresponding frontend repo is available here.

Running locally

Run the following commands to start the application locally.

# Install dependencies
npm install

# Copy the .env.example file in the project root and rename it to .env
cp ./.env.example ./.env

# Modify the placeholder values inside the newly-created `.env` file to your own values

# Start the API
npm run local

Running the tests

If you have not already done so, install dependencies:

npm install

Then, execute the following command:

npm test

Viewing test coverage

npm run coverage