README.md

NOTE: This project was done for the course 1DT003 Computer Systems with Project Work at Uppsala University by the following members:

• AGUPTA375
• Skrotsamlarn
• RichardG99
• Kimiya98901
• JakobPaulsson
• niclasgardsuu
• sgronlund

---

The Real Deal - Backend

This repository hosts the backend of our project, The Real Deal, written in Node.js which communicates with our frontend application which can be found here.

First Time Usage

When you've successfully cloned this repo, enter the src folder and run

npm i

This installs all the dependencies this project requires. This process should not differ from MacOS, Linux or Windows assuming you've successfully installed NodeJS on your host machine.

Usage

To run the application run:

npm start

If everything is working your terminal should look something like this:

Tests

To run tests, you can simply run:

npm test

Documentation

To generate documentation, you can simply run:

npm run document

This will generate the src/out/ folder where index.html will contain all generated documentation.

Clean

To clean up temporary files or files that should not be committed, simply run:

npm run clean