Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sonnyrr/besl
🏆 Bulgarian eSports League. Play competitive tournaments and win prizes! My defense project for ASP.NET Core MVC @SoftUni. Built with ASP.NET Core MVC 2.2, CQRS, MediatR, Redis, SteamWebApi2, Hangfire, SignalR.
https://github.com/sonnyrr/besl
asp asp-net-core-mvc competitive-tournaments cqrs csharp csharp-code hangfire mediatr mvc redis signalr softuni steam
Last synced: about 2 months ago
JSON representation
🏆 Bulgarian eSports League. Play competitive tournaments and win prizes! My defense project for ASP.NET Core MVC @SoftUni. Built with ASP.NET Core MVC 2.2, CQRS, MediatR, Redis, SteamWebApi2, Hangfire, SignalR.
- Host: GitHub
- URL: https://github.com/sonnyrr/besl
- Owner: SonnyRR
- License: mit
- Created: 2019-06-08T15:02:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T07:51:50.000Z (over 2 years ago)
- Last Synced: 2023-02-26T13:36:07.019Z (almost 2 years ago)
- Topics: asp, asp-net-core-mvc, competitive-tournaments, cqrs, csharp, csharp-code, hangfire, mediatr, mvc, redis, signalr, softuni, steam
- Language: C#
- Homepage:
- Size: 5.39 MB
- Stars: 10
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Bulgarian eSports League /pronounced: Be·es·el·/. My defense project for ASP.NET Core MVC course at SoftUni (June-August 2019).
🏆 Awarded 1st place in top 5 best projects (June-August 2019).
[](https://github.com/SonnyRR/BESL/actions/workflows/ci.yml)
[](https://sonnyrr.visualstudio.com/BESL/_build/latest?definitionId=1&branchName=master)
[](https://codecov.io/gh/SonnyRR/BESL)
BESL is an online eSports league for competitive tournaments on various games and formats. Everyone with a Steam account can create a team with their fellow friends and sign up for the current season tournament. Skill levels are represented by tiers and range from Open, Mid and Premiership. Match fixtures are scheduled in play weeks where teams face each other every week in order to reach the top skill table rankings.
# 🛠 Built with:
- CQRS & MediatR
- ASP.NET Core MVC
- NUKE Build System
- EF Core 2.2
- SignalR
- Fluent validation
- Custom exception-based notifications with Redis\*, MediatR & ASP.NET middleware pipelines.
- Hangfire
- Sendgrid
- CloudinaryDotNet
- SteamWebApi2
- Steam.Models
- OpenId.Steam
- Shouldly
- Moq
- MockQueryable
- Coverlet
- Polly
- CodeCov
# ⚙️ Local setup using Docker
The following instructions are tested on `macOS` & `Linux` if you're running a `Windows` machine, you'll have to change certain directory routes in both the `docker-compose` files and `Kestrel` user secrets.
There is also a docker image available under the `packages` tab that is built everytime a `push` is made on the `master` branch if you want to fire it up using `docker run`.
### BESL Application Secrets
1. Make sure you have the following app secrets set in either the 'Secret Manager' or 'Azure KeyVault' if you decide to deploy this application:
- Cloudinary:
- cloudinary-cloud
- cloudinary-apiKey
- cloudinary-apiSecret
- Steam
- steam-api-key
- SendGrid
- sendgrid-api-key
### Creating a development HTTPS certificate
1. Clean development certificates:
```sh
dotnet dev-certs https --clean
```
2. Export the HTTPS certificate using the dev-certs global tool and a password of your choice:
```ps
# Windows
dotnet dev-certs https -v ep ${USERPROFILE}/.aspnet/https/cert.pfx -p aR@ndomPassw0rd
```
```sh
# MacOS/Linux
dotnet dev-certs https -v -ep ~/.aspnet/https/cert.pfx -p aR@ndomPassw0rd
```
3. Trust the new development certificate **[OPTIONAL]**
```sh
dotnet dev-certs https -t #The certificate is trusted automatically after generating it.
```
### Adding the required 'user secrets' for the development HTTPS certificate
\*The user secrets will not be available under 'Production' environment so keep that in mind if you want to run the container with `docker compose` you'll need to temporarily change the `ASPNETCORE_ENVIRONMENT` variable value to `Development` for example.
1. **[Optional]** Initialize the user secrets if you haven't already.
```sh
dotnet user-secrets init
```
2. Run the following commands in the project folder in order to set the certificate path and password:
```sh
dotnet user-secrets remove "Kestrel:Certificates:Default:Password"
dotnet user-secrets remove "Kestrel:Certificates:Default:Path"
dotnet user-secrets set "Kestrel:Certificates:Default:Password" "{your password here}"
dotnet user-secrets set "Kestrel:Certificates:Default:Path" "/root/.aspnet/https/cert.pfx"
```
### Starting the containers
\* The volumes mounted in the `docker-compose` files are Linux/MacOS paths, if you're running Docker + WSL2 make sure that the volumes are mounted correctly:
```yml
volumes:
- ${APPDATA}/Microsoft/UserSecrets:/root/.microsoft/usersecrets:ro
- ${USERPROFILE}/.aspnet/https:/root/.aspnet/https:ro
```
1. Run the following docker command from the root directory of the repository to start up the necessary containers:
```sh
#Development
docker-compose -f docker-compose.yml -f docker-compose.development.yml up
```
📌 **Before running the application under the 'Production' environment ensure that the necessary credentials are added in the appsettings.production.json file. e.g. Azure KeyVault, Redis credentials, etc.**
```sh
#Production
docker-compose -f docker-compose.yml -f docker-compose.production.yml up
```
2. To stop the containers press `CTRL+C` in your terminal client or use the Docker desktop utility.
### Removing the containers
2. To remove all containers used by the application run the following command from the root directory of the repository:
```sh
#Development
docker-compose -f docker-compose.yml -f docker-compose.development.yml down
```
```sh
#Production
docker-compose -f docker-compose.yml -f docker-compose.production.yml down
```