Backend Application Boilerplate

It is a basic application to give you a head start with your backend development

Pre-Requisites

The project uses MySQL as the primary database solution.

Environment requirements

• NODE: 16.13.0
• SEQUELIZE-CLI: 6.3.0

Installation

Use the package manager npm or yarn to install the dependencies.

npm install

Development

To start development, make sure you have the following file set up at config/environments/development.json

{
  "port": YOUR PORT,
  "db": {
    "host": "YOUR HOST",
    "name": "YOUR DATABASE NAME",
    "username": "YOUR DATABASE USERNAME",
    "password": "YOUR DATABASE PASSWORD"
  }
}

Also, have an environment file (config/environments/.env) set up as well, at least it should contain the version of your API, an example .env file can be:

PORT=3000
VERSION=0.0.1

Test

To run the tests, make sure you have a test.json similar to development.json pointing to the same or a different database, to run all the tests run the following command:

npm test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. This project uses github actions to run test, validate code format and styles, make sure to test your PRs before submitting.

npm run lint
npm run prettier
npm test

Please make sure to update tests as appropriate.

License

Social

Status