From 30461189bb8604d34a1f17f07d3d9981356fe9ac Mon Sep 17 00:00:00 2001 From: Reimar Date: Mon, 16 Sep 2024 11:25:24 +0200 Subject: [PATCH] Add setup guide --- Docs/setup.md | 22 ++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 25 insertions(+) create mode 100644 Docs/setup.md diff --git a/Docs/setup.md b/Docs/setup.md new file mode 100644 index 0000000..3c9e48e --- /dev/null +++ b/Docs/setup.md @@ -0,0 +1,22 @@ +## Setting up + +### C# backend + +In the `API` folder, copy `appsettings.example.json` to `appsettings.json` and fill out the values. `AccessKey` and `SecretKey` are for the Cloudflare R2 service. + +Run `dotnet ef database update` and then `dotnet run`. + +### Rust backend + +In the `rust-backend` folder, copy `.env.example` to `.env` and fill out the values. Make sure the JWT secret is the same on both backends. + +Rust can be installed from . After installation, run `rustup default stable` in the terminal. + +To start the backend, run `cargo run`. + +### Flutter + +In the `Mobile` folder, copy `environment.example.json` to `environment.json` and fill out the values. + +Run `flutter run --dart-define-from-file environment.json`. + diff --git a/README.md b/README.md index 6c2c04c..15ca578 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,6 @@ Vi vil udvikle en TuristApp for SkanTravles, som gør brug af telefonens sensore [Kravspecifikation](Docs/kravspec.md) [Logbog](Docs/SCRUM%20Logbog.md) + +[Setup guide](Docs/setup.md) +