SETUP.md

Setup Project Details

Environment config

• Install yarn
• Install docker
• Install docker-compose
• Do post-installation docker steps
• Install VSCode
• Install ALL the extensions recommended in .vscode/extensions.json
• If the changes are not applied automatically add the content of .vscode/settings.json in your personal settings.json

Initial config

• Run yarn husky:config to automatically config husky
• Change the project name on package.json
• Change the name of the project on docker-compose.yml (5 places)
• Change the name of the project in the "docker:clear" script on package.json
• Configure the src/swagger.ts file
• Add project to CodeFactor
• Add project to DeepScan
• Add project to Coveralls
• Update the badges on README.md

After the first test file be added to the project

• Remove "Test TypeScript Syntax" step from .github/workflows/tests.yml
• Remove script "temp:test-tsc" from package.json
• Uncomment steps "Run Tests" and "Colect Coverage" from .github/workflows/tests.yml
• Uncomment "coverageThreshold" from jest.config.js

After all other steps are completed

• Delete this file