- Docker
- C# 12
- .NET 8.0
- PostgreSQL 15
- Docker
- Several .Net packages and tools that can be installed via
dotnet restore
dotnet tool restore
- Clone repository
git clone git@github.com:zpi-2023/SensoBackend.git
cd SensoBackend - Run Docker Compose
docker-compose up --build - Open swagger at
http://localhost:8088/swagger
Make sure you are using http instead of https.
⚠️ The following description is extended to include all common troubleshooting steps. Feel free to skip some steps if you know what you are doing.
- Assign yourself to an issue in this repository
- All issues should be created from the project page
- Ensure the issue has specified labels, status and priority
- Create a new branch, either by
- (or)
git checkout -b <branch-name>from an up-to-datemainbranch - (or) Going to the issue, and clicking "Create new branch" in the "Development" section in the sidebar
- (or)
- Ensure you are using the the correct .NET version:
dotnet --version - Ensure you are using up-to-date dependencies:
dotnet restore - Ensure you are using up-to-date tools:
dotnet tool restore - Ensure you installed husky:
dotnet husky install - Develop your feature
- Move your task to the "In Progress" column
- Make sure to add test coverage whenever possible
- Check that you did not violate any conventions with
dotnet csharpier --check . - Make sure that all tests are passing with
dotnet test - Make sure that db diagram in README is up-to-date
- Commit your changes
- Husky.Net should ensure that your commit does not violate any coding conventions
- Feel free to add multiple commits to your feature, they will get squashed anyway
- Create a PR
- Move your task to the "In Review" column
- Notify the team that your change is pending review
- Feel free to create the PR before finishing and include "DRAFT" in its name
- Make sure your PR is ready to merge
- Wait for at least one review from another team member
- Wait for all CI actions to pass successfully
- Squash and merge! 🚀