https://github.com/wallymathieu/auctions-api-csharp
Simple Auction API : Implementation of different types of auctions
https://github.com/wallymathieu/auctions-api-csharp
auctions
Last synced: 7 months ago
JSON representation
Simple Auction API : Implementation of different types of auctions
- Host: GitHub
- URL: https://github.com/wallymathieu/auctions-api-csharp
- Owner: wallymathieu
- License: mit
- Created: 2023-04-14T07:32:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T19:10:35.000Z (over 1 year ago)
- Last Synced: 2024-05-19T20:25:31.132Z (over 1 year ago)
- Topics: auctions
- Language: C#
- Homepage:
- Size: 723 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Auction API written in C\#
There are currently these main implementations:
- [main](https://github.com/wallymathieu/auctions-api-csharp/tree/main) is the core simple implementation
- [application-layer](https://github.com/wallymathieu/auctions-api-csharp/tree/application-layer) is the implementation with an application layer
- [command-handlers-infrastructure](https://github.com/wallymathieu/auctions-api-csharp/tree/command-handlers-infrastructure) is the implementation but without hand written command handlers that binds to the entity methods
- [command-handlers-mediatr](https://github.com/wallymathieu/auctions-api-csharp/tree/command-handlers-mediatr) is an extension of the command-handlers-infrastructure but with MediatR pipeline behavior instead of decorators
## Getting started
First copy .env sample to a new .env file
```bash
cp .env.sample .env
```
Then do change the password.
To start the database run:
```bash
docker compose up -d db
```
To start azurite run:
```bash
docker compose up -d azurite
```
To start redis run:
```bash
docker compose up -d redis
```
To build the app run:
```bash
cd src/Auctions.WebApi
dotnet publish --os linux --arch x64 -p:PublishProfile=DefaultContainer
```
To run api/func/migrations locally you need the following env:
```bash
source .env
export ConnectionStrings__DefaultConnection="Server=localhost;Database=master;TrustServerCertificate=true;MultipleActiveResultSets=true;User Id=sa;Password=${SA_PASSWORD}"
export ConnectionStrings__Redis="localhost"
export ConnectionStrings__AzureStorage="UseDevelopmentStorage=true"
export AzureWebJobsStorage="UseDevelopmentStorage=true"
```
If you want to run inside dev containers then the setup will be slightly different (since it should be the same environment as you have if you the apps through docker compose):
```bash
. .devcontainer/env.sh
```
To run migrations and api using above environment:
```bash
dotnet tool restore
cd src/Auctions.WebApi
dotnet ef database update
dotnet run
```
In the frontend app you need to specify the frontend db context
```bash
cd src/Auctions.Frontend
dotnet ef database update --context Wallymathieu.Auctions.Frontend.Data.FrontendDbContext
```
To run Azure Functions locally using above environment:
```bash
cd src/Auctions.AzureFunctions
func start
```
## Auth
The API assumes that you have auth middleware in front of the app.
Either the decoded JWT in the `x-jwt-payload` header or specify an encoded claims principal by using configuration value in `PrincipalHeader`, such as `x-ms-client-principal`.
## Add migration
```bash
dotnet ef migrations add NewMigration --project ./src/Auctions.Infrastructure/Auctions.Infrastructure.csproj --startup-project ./src/Auctions.WebApi/Auctions.WebApi.csproj
```
## Inspiration
The main inspiration for the architecture of the API is found in this book:
- [Clean Architecture](https://www.goodreads.com/en/book/show/18043011)
Note that there are many variants of "the clean architecture" described in the .net space with different interpretations of what it means to implement this architecture.