From 9036c5a148d59ce958d93283ee02a922f888f9c6 Mon Sep 17 00:00:00 2001 From: sam Date: Mon, 20 May 2024 17:33:51 +0200 Subject: [PATCH] add development notes to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 90fd1a1..ceefd3e 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,16 @@ code is licensed under the Apache License 2.0 - `Foxchat.Core`: shared classes and model definitions - `Foxchat.Identity`: identity server - `Foxchat.Chat`: chat server + +## Development + +- You need [.NET 8][net8] to build Foxchat. +- You also need the [EF Core tools][efcoretools]: `dotnet tool install --global dotnet-ef` +- During early development the configuration files are checked into Git, + once the software is closer to usable they will be removed and replaced with example files. +- Both servers (Foxchat.Chat and Foxchat.Identity) should be run from their respective directories with `dotnet run`. +- The database can currently be migrated with `dotnet ef database update`, built-in migration will be added later. +- New migrations can be created with `dotnet ef migrations add `. + +[net8]: https://dotnet.microsoft.com/en-us/download +[efcoretools]: https://learn.microsoft.com/en-us/ef/core/cli/dotnet