Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some docs about how to get started in the repo #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 44 additions & 1 deletion README.md
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