Staccato Back-End

This project is a basic web API holding song and album information.

Preparing the project

Install dependencies with the npm install command.
Prepare create a settings.json file in the project root, following this structure:

  API_PORT=8080
  DB_HOST=127.0.0.1
  DB_PORT=3306
  DB_USER=root
  DB_PASSWORD=root
  DB_NAME=staccato

Build the web service with the npm run build command.
Run migrations to ensure your database is up to date, using npm run migrate.
If you wish to insert test data, use the npm run seed command.

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Running in Docker

Run the npm run build:docker command to build the docker container.
Run the npm run start:docker command to compose and start.

In the case of port conflicts, review/edit the docker-compose.yml file accordingly. The docker container is built with seeding for demo purposes. If desired this can be removed from the Dockerfile.

Continuous Integration / Delivery

A basic AppVeyor pipeline has been included in this project. The pipeline simply builds the JavaScript, uploads the "dist" folder as an artifact and calls a webhook.

The pipeline does not build or push the docker image, or actually deploy anywhere, if deployment is required, a deployment webhook may suite.

Documentation

Once the app is running, swagger documentation can be found at the /api route. eg. if you are running the web service locally, navigate to http://localhost:8080/api

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

contact Codie Stella for support.

Last Updated 27/07/22 by Codie Stella 🐧

craftycodie/Staccato-BackEnd