-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some docs about how to get started in the repo
- Loading branch information
1 parent
ac4fde0
commit 90c4679
Showing
1 changed file
with
44 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,44 @@ | ||
# PocketDDD | ||
# PocketDDD | ||
|
||
A Blazor web app and .NET API to make DDD south west even more awesome for attendees. | ||
|
||
## Folders | ||
|
||
`PocketDDD.BlazorClient` - This is the UI | ||
`PocketDDD.Server` - This is the API | ||
`PocketDDD.Shared` - This is shared between the UI and the API | ||
`PocketDDDClient` - This is deprecated, we'll delete it at some point! | ||
|
||
## Getting started | ||
|
||
You will need: | ||
|
||
- .NET 8 | ||
- SQL Server | ||
|
||
### Configuring the backend for the first time | ||
|
||
- Set up the database | ||
- Create a new database | ||
- Run `PocketDDD.Server/PocketDDD.Server.DB/Migrations/FullDBScript.sql` | ||
- Add a row to the `EventDetail` table with `Id=1, Version=1, SessionizeId=<SessionizeId>` | ||
- Set up the API | ||
- Set two user secrets for API (see [Microsoft docs](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-8.0&tabs=windows#secret-manager) if unfamiliar with user secrets) | ||
- `AdminKey` - this is used in an `Authorization` header to access the API | ||
- `ConnectionStrings:PocketDDDContext` - this is the connection string for the database | ||
- Start the API | ||
- Set up the data | ||
- Call the `api/EventData/RefreshFromSessionize` endpoint with the `AdminKey` in an `Authorization` header | ||
- In the database, tidy up the `Tracks` data and add `TimeSlots` for the breaks | ||
|
||
### Running the frontend | ||
|
||
The Blazor web app is designed to be run as a static web app. This means that the `appsettings` files are located inside `PocketDDD.BlazorClient/PocketDDD.BlazorClient/wwwroot`. | ||
There are two settings which can be altered: | ||
|
||
- `apiUrl` - the api the app is pointing to | ||
- `fakeBackend` - whether or not to use a local fake api | ||
|
||
Beware when running the frontend that it caches on the client. The app is designed to be downloaded once and then largely work offline. | ||
|
||
If testing a new UI change then use a new incognito window or delete local storage for the site |