- Docker, alternatively use Podman
- docker-compose, alternatively use podman-compose
- Run
docker compose up
ordocker-compose up
orpodman-compose up
- Alternatively build
docker/Dockerfile
manually and run a seperate redis container withdocker run
orpodman run
- Install modules with
npm ci
- Run dev server with
npm run dev
- Alternatively build project with
npm run build
and run it withnpm run start
- API should be available under port
3000
, you can check by going tohttp://localhost:3000/healthz
- To check if Redis is connected go to
http://localhost:3000/healthz/redis
- To run the audomated tests you must do
Local
setup after which you can start the tests withnpm run test
- Alternatively you can test the API manually by going to
http://localhost:3000/stats/player/Sifiso%20Abdalla
- NodeJS - JavaScript runtime for servers
- NPM - Node Package Manager, used to install required packages
- Fastify - Fast and low overhead web framework for NodeJS
- Redis - Fast in memory data store
- Docker/Podman - Containerized packaging