RS School REST service

Prerequisites

• Git - Download & Install Git.
• Node.js - Download & Install Node.js and the npm package manager.

Downloading

git clone {repository URL}

Installing NPM modules

npm install

Running application

npm start

After starting the app on port (4000 as default) you can open in your browser OpenAPI documentation by typing http://localhost:4000/doc/. For more information about OpenAPI/Swagger please visit https://swagger.io/.

Running application in DOCKER

1. Run in terminal ##docker compose up## if you want to see logs in terminal, else run ##docker compose up -d##
2. Now it works!
3. To stop the application after comand ##docker compose up## enter in terminal ##Ctrl+c##
4. To stop the application after comand ##docker compose up -d## enter in terminal ##docer compose down##
5. Now it stops!
6. If you want to fix or add something in code - do it, and then run ##docker compose build##.
7. If you want to run the application again - see the paragraph above (1).

Testing

After application running open new terminal and enter:

To run all tests without authorization

npm test

To run only one of all test suites (users, boards or tasks)

npm test <suite name>

To run all test with authorization

npm run test:auth

To run only specific test suite with authorization (users, boards or tasks)

npm run test:auth <suite name>

Development

If you're using VSCode, you can get a better developer experience from integration with ESLint and Prettier extensions.

Auto-fix and format

npm run lint

Debugging in VSCode

Press F5 to debug.

For more information, visit: https://code.visualstudio.com/docs/editor/debugging