- Git - Download & Install Git.
- Node.js - Download & Install Node.js and the npm package manager.
git clone {repository URL}
npm install
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/.
docker-compose up
If you want to update the container images with the changes you made, stop docker-compose, if it is running, and run:
docker-compose down
docker-compose build
docker-compose up
To scan images for vulnerabilities, run:
docker scan <image name>
Current migration files stored in migrations folder.
To work with migrations, start the app using:
docker-compose up
When the DB and the app become running, you can use migrations functionality:
-
There is an inital migration file by default, but you can remove it and create your own by running:
npm run migration:generate -
After migration was generated, you can apply changes to the database by running:
npm run migration:run -
You can revert latest migration by running:
npm run migration:revert
In summary, after you started the app using docker-compose, and applied migrations to the DB, you can start testing the application.
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>
If you're using VSCode, you can get a better developer experience from integration with ESLint and Prettier extensions.
npm run lint
Press F5 to debug.
For more information, visit: https://code.visualstudio.com/docs/editor/debugging