Development
Main
- After going through the standard setup instructions
- Install Cargo Watch:
cargo install cargo-watch
- Install the VS Code Plugin Rust Analyzer (opens in a new tab)
- Open one terminal:
cd server
# to compile in debug mode (faster recompiling but slower performance)
DEBUG=true cargo watch -x run
# to compile in release mode (slower recompiling but faster performance)
cargo watch -x 'run -r'
- In a second terminal:
cd client && yarn install && yarn dev
- A browser will automatically open to
localhost:{PORT}
Docs
-
Setup dependencies:
cd docs yarn install
-
Run the docs server:
yarn dev
-
Open the web browser:
# When you see this in the console: ready - started server on 0.0.0.0:3000, url: http://localhost:3000 # Click the url address to open the docs in your browser # Or you can manually navigate to it in the browser
-
When you save your changes, the browser will automatically hot reload to reflect them