Back-end (ASP.NET Core Web API) of the Streetcode project, used as the working codebase of the August 2026 .NET cohort.
The largest platform about the history of Ukraine, built in the space of cities.
To fill the gaps in the historical memory of Ukrainians.
| Repository | project-studying-dotnet/Streetcode-Server-August-2026 |
| Default branch | dev |
| Board | project #30 · Streetcode-August-2026 (private) |
| Team | net-team-august-2026 |
The codebase originates from ita-social-projects/StreetCode. Each cohort starts from the same reference tree rather than from the previous cohort's work. This cohort works on the server only — no client repository is provisioned, and the Streetcode/StreetCode.Client submodule stays uninitialised.
ASP.NET Core 10 · EF Core 10 (SQL Server) · MediatR · AutoMapper · FluentResults · Hangfire · Serilog · Swashbuckle · StyleCop.Analyzers · xUnit · Nuke Build
- .NET SDK 10.0 — the solution targets
net10.0 - Visual Studio 2026 (Version 18.0), JetBrains Rider, or VS Code. Visual Studio 2019 & 2022 do not support
net10.0and cannot open this solution. - SQL Server 2019+ (Express edition is enough) or Docker Desktop
git clone https://github.com/project-studying-dotnet/Streetcode-Server-August-2026.git
cd Streetcode-Server-August-2026dev is the default branch and the base for all work.
Make sure Docker Desktop is running in Linux containers mode. Copy the tracked environment template before starting the services:
cp .env.example .envThen replace the Docker Compose placeholders in .env with values appropriate for the local environment:
MS_SQL_DB_PORT=1433
API_PORT=5000
SA_PASSWORD=your-strong-password
DB_USER=sa
DB_NAME=StreetcodeDbBuild and start the Web API and SQL Server:
docker compose up --buildThe SQL Server health check prevents the API from starting before the database is ready. On startup, the API applies the Entity Framework Core migrations automatically.
When both services are running, the application is available at:
| Swagger UI | http://localhost:5000/swagger |
| HTTP | http://localhost:5000 |
| Hangfire dashboard | http://localhost:5000/dash |
| SQL Server | localhost:1433 |
Docker Compose uses the Local environment to enable Swagger. The Hangfire dashboard remains available, but recurring background jobs are not registered in this environment, so the dashboard can be empty.
Useful commands:
docker compose ps # show service status
docker compose logs -f api # follow API logs
docker compose up -d # start in the background
docker compose down # stop and remove the containersThe sqlserver-data volume preserves database data when the containers are stopped or recreated. To remove the containers together with the database data, run docker compose down --volumes.
The application reads the database connection string from the standard ConnectionStrings:DefaultConnection configuration key.
For host-based local development, replace the relevant placeholders in .env with values appropriate for the local environment.
The STREETCODE_ prefix is removed by the environment configuration provider, and the double underscore __ represents the configuration section separator :. Therefore, STREETCODE_ConnectionStrings__DefaultConnection overrides ConnectionStrings:DefaultConnection.
The .env file is ignored by Git and must never be committed. Do not put real credentials in appsettings*.json or .env.example.
The STREETCODE_Blob__BlobStoreKey value is required when media files are encrypted or decrypted. Set it in the local .env file to a private key whose UTF-8 representation is exactly 32 bytes, as required for AES-256. The application may start when this value is empty or invalid, but media upload and download operations will fail. Never commit the real encryption key.
Docker Compose configures the containerized API to connect to the sqlserver service automatically. The following override is only needed when running the API directly on the host with a local named SQL Server instance.
Set STREETCODE_ConnectionStrings__DefaultConnection to a complete connection string for the local SQL Server instance. For a named SQL Server instance, the Server value can be set to something such as localhost\SQLEXPRESS.
EF Core, Hangfire, and DbUpdate read the same ConnectionStrings:DefaultConnection configuration value.
The examples use TrustServerCertificate=True only for local development, where SQL Server may use a self-signed certificate. Production environments should use a properly configured and validated server certificate.
Env.NoClobber().TraversePath().Load() searches for .env in the current directory and its parent directories, so locating the root .env file no longer requires the repository root to be used as the working directory. Existing process environment variables take precedence, while .env only fills in values that are missing.
The schema is created on startup — ApplyMigrations runs MigrateAsync(), so an empty database is enough. Seed data is not loaded: the SeedDataAsync() call in Program.cs is commented out, so endpoints return empty collections until data is added.
Set Streetcode.WebApi as the startup project and use the Streetcode_Local launch profile, or:
dotnet run --project Streetcode/Streetcode.WebApi --launch-profile Streetcode_Local| Swagger UI | https://localhost:5001/swagger |
| HTTP | http://localhost:5000 |
| Hangfire dashboard | /dash |
The Local environment is what enables Swagger and suppresses the recurring background jobs. Under any other profile Swagger is off, HSTS is on, and Hangfire starts web-parsing jobs — use Postman or another client against http://localhost:5000.
Run dotnet dev-certs https --trust once, since the pipeline enforces HTTPS redirection.
A missing connection string stops startup with an explicit configuration error. A non-empty but invalid or unreachable database connection is logged by
ApplyMigrations, while the host continues to start and subsequent database requests fail. Look forAn error occured during startup migrationin the console.
dotnet test Streetcode/Streetcode.XUnitTest # unit tests
dotnet test Streetcode/Streetcode.XIntegrationTest # integration testsIntegration tests that require a database use the same STREETCODE_ConnectionStrings__DefaultConnection environment variable. Point it to a separate test database, such as StreetcodeDbtest, and never reuse production credentials. The appsettings.IntegrationTests.json file contains only non-sensitive environment-specific settings.
StyleCop.Analyzers is wired through Streetcode/settings.ruleset. Its findings are warnings and do not fail the build; the reference tree already carries a large number of them, so keep new code clean rather than trying to zero the counter.
Membership in the net-team-august-2026 team grants push on the repository and WRITER on the board — these are two separate access lists. Do not fork: branches are created directly in this repository.
| Branch | Purpose | Approvals to merge |
|---|---|---|
dev |
default, integration branch, base of every PR | 2 |
main |
release | 1 |
Both branches are protected: no force-push, no deletion, stale approvals are dismissed on a new push, and every conversation must be resolved.
Name a working branch after the task:
type/SSAD-<number>/short-description
for example feature/SSAD-42/add-partner-endpoint. Start it from an up-to-date dev:
git switch dev && git pull
git switch -c feature/SSAD-42/add-partner-endpointSprint iterations last 7 days and start on Wednesday. A task travels the board as:
Sprint N Backlog (draft) → Convert to issue → Todo → In Progress → To Review → Sprint N Done
Convert the draft to an issue before starting, so the work has a number to reference from the branch and the PR.
- Push the branch and open a PR into
dev; move the card toTo Review. - Fill in the template and assign reviewers.
- Collect 2 approvals. Any new commit dismisses existing approvals, so push fixes before asking for the final review.
- Resolve every conversation — it is enforced by branch protection.
- Merge the PR yourself once the checks above are met.
- Delete the branch manually (auto-delete is off) and move the card to
Sprint N Done.
Before requesting review, sync with dev and resolve conflicts locally:
git switch dev && git pull
git switch feature/SSAD-42/add-partner-endpoint
git merge devBranch off dev, fix, and open a PR back into dev under the same rules. main receives changes only by merging dev as a release.
Streetcode/
├── Streetcode.WebApi/ controllers, DI and pipeline configuration, entry point
├── Streetcode.BLL/ business logic: MediatR handlers, DTOs, services
├── Streetcode.DAL/ EF Core entities, DbContext, migrations, repositories
├── Streetcode.XUnitTest/ unit tests
├── Streetcode.XIntegrationTest/integration tests
└── DbUpdate/ DbUp runner for the raw SQL scripts in DAL/Persistence/ScriptsMigration
build/ Nuke Build targets
Inherited from the reference tree and left as is:
- The GitHub Actions workflows target
master/developand an upstream SonarCloud project whose token this repository does not hold. A red check on a PR is expected and does not block a merge — no status checks are required by branch protection. .github/PULL_REQUEST_TEMPLATE/develop.mdandmaster.mdare leftovers named after branches that no longer exist. GitHub uses.github/pull_request_template.md.- The
.editorconfigreferenced by the project files is absent.
Visual Studio will not open the solution.
Use a version of Visual Studio that supports .NET 10. The 2019 & 2022 release cannot load net10.0 projects.
Startup logs a migration error and every request fails. The database is unreachable — see Database. The host starts regardless, so the log is the only signal.
Swagger returns 404.
The application is running under a profile other than Streetcode_Local. Swagger is registered only for the Local environment.
All endpoints return empty collections.
Expected on a fresh database: seeding is disabled in Program.cs.
- MIT license
- Copyright 2022 © SoftServe IT Academy.