dotnet-version:'8.0.x'

build-configuration:'Release'

sonar-organization:'personalprojcts'

sonar-project-key:'mayconht_Aristotle_Study'

sonar-project-key:'mayconht_Aristotle_Demo'

test-project-path:'USR/UserServiceTests/UserService.UnitTests.csproj'

solution-path:'Aristotle_Study.sln'

build-artifact-name:'build-state-${{ github.sha }}'

*This project serves as a learning exercise comparing C#/.NET development patterns with Java/Spring Boot, focusing on

Clean Architecture principles and modern development practices.*

<divalign="center">

[](https://github.com/mayconht/Aristotle_Study/actions/workflows/ci-pipeline.yml)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Study)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

[](https://sonarcloud.io/summary/new_code?id=mayconht_Aristotle_Demo)

</div>

-**.NET 8.0** - Target framework

-**ASP.NET Core Web API** - Web framework

-**Entity Framework Core 9.0** - ORM withSQLite andPostgreSQLproviders

-**PostgreSQL** - Alternative database (configurable)

-**Entity Framework Core 9.0** - ORM with PostgreSQLprovider

-**PostgreSQL** - Alternative database

-**AutoMapper** - Object-to-object mapping

-**DotNetEnv** - Environment variable loader

-**Swagger/OpenAPI** - API documentation (Swashbuckle.AspNetCore)

-**Keycloak** - OAuth2/OIDC identity provider for authentication

-**JWT Bearer** - Token-based authentication

<divalign="center">

<imgwidth="769"height="376"alt="image"src="https://github.com/user-attachments/assets/df6efdf8-cb2b-4731-a5e2-4e78a855e76b" />

<imgwidth="1181"height="722"alt="image"src="https://github.com/user-attachments/assets/e4f1d6b3-36d9-4f28-8cbe-0ccd068b6116" />

</div>

The project follows Clean Architecture principles with the following layers:

1.**Access SonarCloud Settings**:

- Go to[SonarCloud](https://sonarcloud.io/) and log in

- Select your project`mayconht_Aristotle_Study`

- Select your project`mayconht_Aristotle_Demo`

- Navigate to "Administration" > "Analysis Method"

2.**Configure Analysis Method**:

3.**Required GitHub Secrets**:

-`SONAR_TOKEN`: Your SonarCloud API token (from SonarCloud user settings)

For local code quality analysis, you can run SonarQube using Docker Compose:

docker-compose up -d

The application supports hot reload with`dotnet watch` which provides:

The API provides user management functionality. Check the Swagger documentation for complete API details:

-`GET /api/users` - Get all users

-`GET /api/users/{id}` - Get user by ID

-`PUT /api/users/{id}` - Update user

-`DELETE /api/users/{id}` - Delete user

**Note**: User creation is handled automatically through JIT provisioning on first login via Keycloak.

The project uses SQLite with Entity Framework Core:

-**Database file**:`users.db` (created automatically)

-**Migrations**: Located in`Migrations/` folder

-**Context**:`ApplicationDbContext` in Infrastructure layer

To create new migrations:

cd UserService

dotnet ef migrations add<MigrationName>

dotnet ef database update

1. Make code changes in your IDE

6. Run tests to make sure everything works

7. Repeat!

- xUnit for test execution

- Moq for mocking dependencies

- Bogus for generating fake test data

- Verify for snapshot testing

- Verify for snapshot testing - TODO

This is an educational project, but contributions are welcome! Areas for improvement include:

- Increase test coverage from 45% to 80%

- Fix .NET compiler warnings

- Address SonarQube security hotspots

- Add integration tests

**Port Issues**: If default ports are in use, modify the URLs in`Properties/launchSettings.json`

**Database Issues**: Delete`users.db` file to reset the database (it will be recreated automatically)

**Build Issues**: Run`dotnet clean` followed by`dotnet restore` and`dotnet build`