• Getting Started
• Scripts
• CLI
• Typescript
• Database
• Testing

Getting Started

Prerequisites:

• Node.js
• Yarn

Installation:

yarn install

Add a .env file with some values before creating docker services

POSTGRES_HOST=postgres
POSTGRES_USER=user
POSTGRES_DB=typed-json-api
POSTGRES_PASSWORD=password
POSTGRES_PORT=5432

Starting postgres & redis:

docker-compose up -d

Starting server (development):

yarn start

Scripts

CLI

Typescript

The server & tests are run using node-ts during development.

Database

Testing

yarn test