103 lines
4.3 KiB
Markdown
103 lines
4.3 KiB
Markdown
# RpgRoller
|
|
|
|
Fresh full-stack starter scaffold:
|
|
|
|
- `RpgRoller/`: ASP.NET Core backend + Blazor frontend host (`Components` + `wwwroot`)
|
|
- `RpgRoller.Tests/`: xUnit integration-heavy test project
|
|
- `RpgRoller.sln`: solution used by local CI script
|
|
|
|
Test layout:
|
|
|
|
- `RpgRoller.Tests/Api/`: API integration tests grouped by feature concern
|
|
- `RpgRoller.Tests/Services/`: service-level tests grouped by domain concern
|
|
- `RpgRoller.Tests/Support/`: shared test harnesses/builders/helpers
|
|
|
|
## Code Organization
|
|
|
|
Backend:
|
|
|
|
- `RpgRoller/Program.cs`: thin app bootstrap only
|
|
- `RpgRoller/Hosting/`: service registration + startup initialization
|
|
- `RpgRoller/Api/`: endpoint mapping modules and auth/session filter helpers
|
|
- `RpgRoller/Services/`: game workflows with explicit method parameters (no API DTO dependencies)
|
|
|
|
Frontend:
|
|
|
|
- `RpgRoller/Components/`: Blazor root app, routes, layout and page components
|
|
- `RpgRoller/Components/Pages/Home.razor`: minimal gateway page (loading/auth/workspace switch)
|
|
- `RpgRoller/Components/Pages/Home.razor.cs`: single `Home` code-behind with only gateway/session-view orchestration
|
|
- `RpgRoller/Components/Pages/Workspace.razor`: authenticated workspace UI and workspace-specific state/logic
|
|
- `RpgRoller/Components/**/*.razor.cs`: component code-behind classes (state, handlers, parameters, injected dependencies); `.razor` files remain markup-focused
|
|
- `RpgRoller/Components/Pages/Home.Models.cs`: reusable `FormState<TModel>` + page form models
|
|
- `RpgRoller/Components/Pages/HomeControls/`: auth, campaign management, play-screen, and modal controls extracted from `Home.razor`
|
|
- Form ownership model: controls own transient form/error state and execute their concern-specific API mutations directly
|
|
- Skill create/edit workflow ownership: `CharacterPanel` (characters own skills in UI and behavior)
|
|
- `RpgRoller/Components/RpgRollerApiClient.cs`: shared browser API client used by `Home`, `Workspace`, and leaf controls
|
|
- `RpgRoller/wwwroot/js/rpgroller-api.js`: browser-side API + SSE + session storage interop for Blazor
|
|
- `RpgRoller/wwwroot/styles.css`: responsive UX styling and theme tokens
|
|
|
|
Backend state persistence:
|
|
|
|
- EF Core with SQLite (`Microsoft.EntityFrameworkCore.Sqlite`)
|
|
- Development DB: `RpgRoller/App_Data/rpgroller.development.db`
|
|
- Default DB: `RpgRoller/App_Data/rpgroller.db`
|
|
- Database schema is created/upgraded automatically on startup via EF Core migrations (`Database.Migrate`)
|
|
- Runtime state is loaded once at startup into memory and written back to SQLite on successful state changes
|
|
|
|
Gameplay capabilities now include:
|
|
|
|
- Skill groups per character with skill prototypes (create/edit/delete groups, assign/reassign skills, and prefill new skill forms from group defaults)
|
|
- Skill and skill-group deletion flows
|
|
- GM-driven character owner transfer within campaign management flows
|
|
|
|
## Prerequisites
|
|
|
|
- .NET SDK 10.0+
|
|
- PowerShell 7+
|
|
- Run `dotnet tool restore` once to enable the repo-local `dotnet-ef` command.
|
|
|
|
## Local Development
|
|
|
|
1. Run the local CI parity script:
|
|
```powershell
|
|
pwsh ./scripts/ci-local.ps1
|
|
```
|
|
2. Start the backend:
|
|
```powershell
|
|
dotnet run --project RpgRoller/RpgRoller.csproj
|
|
```
|
|
3. Open `http://localhost:5000` (or the port shown in the console).
|
|
|
|
VS Code F5 debug profiles are available in `.vscode/launch.json`:
|
|
|
|
- `RpgRoller: Server`
|
|
- `RpgRoller: Server + Edge (F5)`
|
|
- `RpgRoller: Server + Firefox (F5)`
|
|
|
|
To use a custom SQLite database path, set `ConnectionStrings__RpgRoller`.
|
|
|
|
For migration authoring, use the local tool command form:
|
|
|
|
```powershell
|
|
dotnet dotnet-ef migrations add <MigrationName> --project RpgRoller/RpgRoller.csproj --startup-project RpgRoller/RpgRoller.csproj
|
|
```
|
|
|
|
## Frontend Runtime
|
|
|
|
- Runtime frontend is Blazor Server with interactive components.
|
|
- Browser interop is in `RpgRoller/wwwroot/js/rpgroller-api.js`.
|
|
- OpenAPI contract source remains at `openapi/RpgRoller.json`.
|
|
|
|
## Test and Coverage
|
|
|
|
- Tests:
|
|
```powershell
|
|
dotnet test RpgRoller.Tests/RpgRoller.Tests.csproj --collect:"XPlat Code Coverage" --settings RpgRoller.Tests/coverlet.runsettings
|
|
```
|
|
- Coverage gate:
|
|
```powershell
|
|
pwsh ./scripts/check-coverage.ps1 -MinLineRate 0.90 -MinBranchRate 0.70
|
|
```
|
|
- Coverage collector scope:
|
|
- `RpgRoller.Tests/coverlet.runsettings` now measures the full backend assembly (`RpgRoller`), not only service namespace files.
|