ts-service-seed

Template for TS service

Prerequisites

1. NodeJS LTS (12+)
2. Yarn

Install

yarn

Starting server

yarn start

Parameters

The following environment variables can be used to configure the service:

• PORT to set on which port the service should run (default: 3000)

API

Method	URL	Description	Response
GET	/hello	Example API call	{ hello: "world" }

API for tests

Method	URL	Description	Response
GET	/db	Returns the DB	{...}
GET	/clean	Cleans the DB	{}

Docker

To build the image:

docker build -t ts-service:latest .

Run service

docker run -d -p 3000:3000 ts-service:latest

Docs

For detailed documentation see the TypeDocs documentation.