starter-api-ts

Starting point of a new api in order to achieve RAD (rapid application development)

Installation

npm install
rm -rf .git
git init
git remote add origin <repo_url>

• Renamed all occurence of starter-api-ts in code (README and package.json)

Usage

Develop

npm run dev

Application will be running on: http://localhost:4000

Start

Start the application in a particular environment

npm run start:<env>

Start the application locally using specific env params (ex: .env.production and config/production.js)

Build

npm run build

Build application using typescript

Lint

npm run lint

Test

npm run test

All Tests use Jest framework. tests are in *.test.js files

Release

make release tag=x.y.z

The final step. Build and push a tagged docker image

Docker

Every docker related command are in the makefile file.

make help

Further docs

express lodash dotenv rxjs jest