KidsClub Analytics Backend

Description

JSON REST-style API that processes and exposes data about the kids club, its members, and games played.

Built on top of Nest, a TypeScript framework starter repository.

Please have docker installed to run app with a single command.

Using npm

$ npm install -g pnpm

Install dependencies

$ pnpm install

# development
$ docker-compose up -d

This will launch two containers (the nest api app and postgres db instance) in the default local ports (3000 and 5432 respectively).

Access the Swagger UI at http://localhost:3000

# unit tests
$ pnpm test

# test coverage
$ pnpm test:cov