ReiMerc/skantravels
2
0
Fork 1
Code Issues Pull Requests 1 Packages Projects 1 Releases Wiki Activity

Add setup guide

Browse Source
This commit is contained in:
Reimar 2024-09-16 11:25:24 +02:00
parent e8ed845f10
commit 30461189bb
Signed by: Reimar
GPG Key ID: 93549FA07F0AE268
2 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Docs/setup.md Normal file
View File

@ -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 <https://rustup.rs>. 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`.

3
README.md
View File

@ -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)