From 90c46794acab98d64b25243791620facc97fc677 Mon Sep 17 00:00:00 2001
From: Sara Gowen <me@dynamictulip.com>
Date: Sun, 21 Apr 2024 15:45:13 +0100
Subject: [PATCH] Add some docs about how to get started in the repo

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8a63b7c..739448f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,44 @@
-# PocketDDD
\ No newline at end of file
+# 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