This project uses a Node.js server with Express, along with a Postgres database to store the data. There's no front end, but it uses Swagger to show the available endpoints and to allow testing them out.
- Docker
- Node (any recent version is fine. I used 22.14.0)
- Make sure that the json data files are in the
datadirectory - Run the following commands to create the database and import the json files:
docker compose up -dnpm installnpm run initialise-database(this can take around 20 seconds)
- Run
npm startto start the server - Go to http://localhost:3000/swagger to view & use the available endpoints
- Run
npm run testto run the unit tests - Run
npm run test:integrationto run the integration tests. Make sure your Docker container is running first.