https://github.com/audacioustux/helpdebuggov
.net academic course - final project -- nothing serious :)
https://github.com/audacioustux/helpdebuggov
boilerplate devcontainer dotnet-core jwt sveltekit swagger
Last synced: 28 days ago
JSON representation
.net academic course - final project -- nothing serious :)
- Host: GitHub
- URL: https://github.com/audacioustux/helpdebuggov
- Owner: audacioustux
- License: mit
- Created: 2022-12-13T12:27:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-26T05:55:46.000Z (over 3 years ago)
- Last Synced: 2025-03-11T22:20:39.533Z (over 1 year ago)
- Topics: boilerplate, devcontainer, dotnet-core, jwt, sveltekit, swagger
- Language: C#
- Homepage: https://audacioustux.com
- Size: 836 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HelpDebugGov
## Getting Started
### Prerequisites
- Docker
- IDE/Platform with devcontainer support (e.g., VSCode, Github Codespaces)
- Put necessary environment variables in `.env` file (see `.env.example`)
### Overview
#### Implemented
- Dynamic Policy Based Auth
- Mediator pattern
- CRUD Operations for all entities
- Email Service
- Validation
- Code-First Migration & Seeding
- Logging
- Api Documentation
- Auth, Email Confirmation, Password Reset & Change
- Web UI
#### Used
- ASP.NET 7
- EntityFrameworkCore
- DevContainer
- FluentEmail
- FluentValidation
- MediatR
- AutoMapper
- Serilog
- Swagger
- JWT
- SvelteKit
- TailwindCSS
- Pnpm + TurboRepo
#### Architecture
- src/HelpDebugGov.
- Api - Web Api
- Domain - Domain Models
- Application - Application Services
- Infrastructure - Data Access Layer
- UI - Web UI
### Notes
- scripts/merge-gitignore.sh - merge all *.gitignore files into one
- all sensitive data should be stored in environment variables via `.env` file
- errors should not expose sensitive data to the client
- devcontainer is used for development and highly recommended
- an account with all permissions (superuser) is created (as seed) with given credentials in `.env` (SUPERUSER_*)
#### Commands
``` bash
# Run Api Server
dotnet watch run --project ./src/HelpDebugGov.Api/ --launch-profile https
# Add new Migration
dotnet ef migrations add Init --startup-project ./src/HelpDebugGov.Api/ --project ./src/HelpDebugGov.Infrastructure
# Drop Database
dotnet ef database drop --startup-project ./src/HelpDebugGov.Api/ --project ./src/HelpDebugGov.Infrastructure
# Web UI in dev mode
pnpm run dev
```
### TODO
- [ ] Add tests
- [ ] Add Production Setup
- [ ] Complete OpenTelemetry setup
- [ ] Migrations should be included in version control, but ensure no sensitive data is included
- [ ] resolve `TODO:`s in code (find all with `$ rg "// TODO:"`)
- [ ] - workaround: re-`run`
### References
-
-