diff options
| author | GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> | 2022-11-28 19:10:50 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-28 19:10:50 +0100 |
| commit | c52a78c2687a308187f6ee2fa3ff67486ac7d324 (patch) | |
| tree | 885f950dce53b27241390d88fd279d54ea17fc40 | |
| parent | bebd516ba9a61ea5caf46a629aef5bb9cc591c14 (diff) | |
| download | FlightCore-c52a78c2687a308187f6ee2fa3ff67486ac7d324.tar.gz FlightCore-c52a78c2687a308187f6ee2fa3ff67486ac7d324.zip | |
docs: Mention design goals of FlightCore (#81)
| -rw-r--r-- | docs/DEVELOPMENT.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index 3eb0a72d..a003aa89 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -2,6 +2,14 @@ FlightCore uses [Tauri](https://tauri.app/) as its UI framework. This means it is split into a **backend** written in [Rust](https://www.rust-lang.org/) and a frontend written in [Vue](https://vuejs.org/) and [TypeScript](https://www.typescriptlang.org/). +## Design goals + +In general FlightCore should _just workâ˘_ for the majority of people using it. All errors should be caught and handled where possible. Thanks to CI and auto-updating, releases are easy to deploy and should be made whenever new features are available. + +Pro-user and developer oriented features should be hidden by default to avoid users activating them by accident but still easy enough to access such that it doesn't become a hassle using them. + +As for splitting logic between _frontend_ and _backend_, state and UI related logic should be done in frontend while all the remaining logic is done in backend. The backend should not hold state to avoid any concurrency issues in regards to asynchronous and multithreaded calls into the backend. + ## Setup Make sure you have the necessary dependencies installed: https://tauri.app/v1/guides/getting-started/prerequisites |