RESTful API Node Server Boilerplate

A boilerplate/starter project for quickly building RESTful APIs and with typescript 🚀

Installation

Install the dependencies:

yarn install

Set the environment variables:

cp .env.example .env

# open .env and modify the environment variables (if needed)

Running locally:

yarn dev

Kill locally:

yarn kill

Running in production:

yarn start:dev

Testing:

# run all tests
yarn test

Build:

yarn build

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.