add development notes to README
This commit is contained in:
parent
8995213d26
commit
9036c5a148
1 changed files with 13 additions and 0 deletions
13
README.md
13
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 <name>`.
|
||||
|
||||
[net8]: https://dotnet.microsoft.com/en-us/download
|
||||
[efcoretools]: https://learn.microsoft.com/en-us/ef/core/cli/dotnet
|
||||
|
|
Loading…
Reference in a new issue