Black-circle. Backend

How to run for development

1. In the root directory create .env and paste there the contents of the .env.example file.
2. Install dependencies: npm install.
3. Create docker image: docker compose up
4. Run all migrations: npm run migration:run
5. Start the server: npm run start:dev

How to contribute

1. Clone the develop branch (pull if already cloned) git pull develop
2. Create a new feature branch git checkout -b feature/your_feature and make your changes
3. Commit your changes git commit -m"commit message"
4. Move to develop branch and pull again git checkout develop + git pull
5. Go back to the feature branch git checkout feature/your_feature
6. Update the feature branch with the last pulled changes from the remote develop branch git merge develop
7. Push the changes to your remote feature branch git push --set-upstream origin feature/your_feature
8. Go to github.com and make a PR from your feature branch to develop branch.

Technologies

• Nest.js - a backend framework.
• MySQL - relational DB
• Docker - containerization software
• TypeOrm - an ORM.
• Swagger.js - autogenerating API documentation