Purpose

Use this repo as the starting point for all future API projects

Tech Stack

Language: NodeJS/Typescript Webserver: ExpressJS Database: PostgreSQL ORM: TypeORM Cache: Redis

Getting started with development

1. Clone this repo
2. Grab a working .env file from another developer and place it in the project root
3. Install node v14.x and yarn v1.x
4. Install docker and docker-compose
5. docker-compose down && docker-compose up to start postgres, redis and pgadmin
6. yarn install to install the project's dependencies
7. yarn dev to start the API server in watch mode