diff options
| author | GeckoEidechse <gecko.eidechse+git@pm.me> | 2022-08-26 13:25:38 +0200 |
|---|---|---|
| committer | GeckoEidechse <gecko.eidechse+git@pm.me> | 2022-08-26 13:25:38 +0200 |
| commit | da980bd8eb5912dc5b0097038669b38f8db03a37 (patch) | |
| tree | 19194f4ef89f9748e85336a18af4ae71a8245e21 /README.md | |
| parent | c28e67f262180c84fecbbee7dcbaaa217c836ba3 (diff) | |
| download | FlightCore-da980bd8eb5912dc5b0097038669b38f8db03a37.tar.gz FlightCore-da980bd8eb5912dc5b0097038669b38f8db03a37.zip | |
Add development guide to README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 33 insertions, 1 deletions
@@ -41,4 +41,36 @@ Then ```rs tauri::Builder::default() .manage(arc_db) -```
\ No newline at end of file +``` + +## Development + +Make sure you have the necessary dependencies installed: https://tauri.app/v1/guides/getting-started/prerequisites + + +Install `npm` dependencies with + +```sh +npm install +``` + +Then for developing + +```sh +# terminal 1 (UI localhost for hot-reload) +npm run ui-dev + +# terminal 2 (for the Rust/App hot-reload) +npm run tauri dev +``` + +> **Note** +> On Windows instead of `npm run ui-dev`, you may need to run +> `./node_modules/.bin/rollup --config --watch` +> and +> `npm run localhost` +> in two separate console windows + +### Building + +Release builds are generally done via CI. To build locally, make sure typescript is compiled (`./node_modules/.bin/rollup --config`), then run `npm run tauri build`. |