piojablonski/cl-assignment

Decisions and thought process

• I documented decisions here in two parts:
  • initial decisions made before I started the assignment
  • log the decisions made while writing the assignment available also through

  git log --reverse --pretty=format:"%m %ah: %s %n %b"
  

Installation

$ npm install

Building and running for development

# run a database 
$ docker run -d -p 6379:6379 redis:7.0.11

# create .env file, modify if necessary
$ cp env.example .env

# development
$ npm run start

# watch mode
$ npm run start:dev

• application is available on http://localhost:3000
• api documentation is available on http://localhost:3000/api

Building and running using docker compose

# run the application on default port 3000
# application is available on http://localhost:3000
# api documentation is available on http://localhost:3000/api
$ docker compose up -d

# check if app is up and running
$ curl http://localhost:3000/healthz

Running automated tests

# download redis image before running the tests to avoid timeout
$ docker pull redis:7.0.11

# unit tests
$ npm run test