MMichotte/make-kots-great-again__web

web app

API

Documentation available here

Run locally

Prerequisites

• Docker

Usage

• Clone the GitHub repo.
• Run docker-compose up -d in the root directory and hit http://localhost:8000 in your browser.

Database usage

• Exec into the PostgreSQL container with the following command : docker exec -ti postgres-container psql -U postgres

Useful psql commands

• \l - list all the database(s)
• \c DATABASE_NAME - connect to a specific database
• \c kots - connect to kots database
• \dt - list all tables in the current database
• select * from users; - list all users from the table users
• \! clear - clear the screen in psql
• \q - quit psql

Backend usage

• Exec into the node.js container with the following command : docker exec -it kots-server sh

• If you want to run in the container any npm scripts inside the package.json, change the server port cause 8000 is already in use.

• For more info check the API documetaion here

Integration Test Code Coverage

The code coverage available here

Integration Test Report

Integration tests report available here

Unit Test Code Coverage

The code coverage available here

Unit Test Report

Unit tests report available here

End to End Tests

E2E tests report available here

Lighthouse Report

Lighthouse report available here