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.

Installation

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

Install pnpm:

Using npm

$ npm install -g pnpm

Install dependencies

$ pnpm install

Running the app

# 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).

See it in Action

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

Test

# unit tests
$ pnpm test

# test coverage
$ pnpm test:cov

Stay in touch

• Author - Donald Granados
• Github - https://github.com/donaldG21
• Email - [email protected]