NodeJs Typescript Starter

Starter repository for developing fast API services with typescript and fastify. Docker friendly with default CI configuration.

Requirements

Following software is required to be installed to use this repo:

• NodeJs >= v12
• Yarn
• Docker
• docker-compose

Usage

• yarn install - will run and configure everything for you

Database

• use yarn db:migration:new <class name> to generate new empty migration file (same goes for entity and subscriber)
• use docker-compose exec backend yarn db:migration:generate <class name> to generate new auto generated migration
• yarn db:migrate - runs all pending migrations against database
• yarn db:revert - reverts last migration, run multiple times to revert everything
• yarn db:seed - seeds database with fake data (src/services/db/seeders)
• yarn run test:unit - runs unit tests with coverage
• yarn run lint runs following commands:
  • yarn run lint:style - runs eslint against source code
  • yarn run lint:types - checks typescript types
• yarn run start:dev - runs docker-compose with your server and database, app will autoreload on changes