gburri/recipes
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity Actions

Doc

Browse source
This commit is contained in:
Greg Burri 2025-03-18 19:55:52 +01:00
parent 7230ca607d
commit 8dcaac35b7
2 changed files with 301 additions and 298 deletions
Download patch file Download diff file Expand all files Collapse all files

128
README.md
View file

@ -1,63 +1,65 @@
# Technical
## Backend
### Launch Axum
In directory '/backend' type:
$> cargo run
Then browse http://127.0.0.1:8082 (You need to compile the wasm file first, see section 'Frontend')
At first launch the configuration file '/backend/conf.ron' is created. It contains the port the server will listen to and information about the SMTP server which will be used to send email when a user sign up or change its password.
### Autoreload
First install cargo watch:
$> cargo install cargo-watch
In directory '/backend' type:
$> cargo watch -x run
## Frontend
### Tools needed
nushell: https://www.nushell.sh/
trunk: https://trunkrs.dev
### Compilation
In directory '/frontend' type:
$> nu deploy.nu
It will create the '/frontend/pkg' directory and copy the wasm file into '/backend/static'.
You can now refresh your browser to reload the wasm file.
# How-to
## How to install service on a Linux server
As root:
1. Copy '/doc/recipes.service' to '/lib/systemd/system/'
2. Enabled it: #> systemctl enable recipes
3. Launch it: #> systemctl start recipes
## Cross compile for Raspberry PI on Windows
* $> https://gnutoolchains.com/raspberry/
* https://gnutoolchains.com/raspberry64/
# Useful URLs
* Rust patterns : https://github.com/rust-unofficial/patterns
* Rust cheat Sheet: https://cheats.rs/
# Useful tools
Benchmarking: https://crates.io/crates/oha
HTTP API tool: https://www.usebruno.com/
GUI Database client: https://dbeaver.io/
# Technical
## Backend
### Launch Axum
In directory '/backend' type:
$> cargo run
Then browse http://127.0.0.1:8082 (You need to compile the wasm file first, see section 'Frontend')
At first launch the configuration file '/backend/conf.ron' is created. It contains the port the server will listen to and information about the SMTP server which will be used to send email when a user sign up or change its password.
### Autoreload
First install cargo watch:
$> cargo install cargo-watch
In directory '/backend' type:
$> cargo watch -x run
## Frontend
### Tools needed
nushell: https://www.nushell.sh/
trunk: https://trunkrs.dev
### Compilation
In directory '/frontend' type:
$> nu deploy.nu
It will create the '/frontend/pkg' directory and copy the wasm file into '/backend/static'.
You can now refresh your browser to reload the wasm file.
# How-to
## How to install service on a Linux server
As root:
1. Copy '/doc/recipes.service' to '/lib/systemd/system/'
2. Enabled it: #> systemctl enable recipes
3. Launch it: #> systemctl start recipes
## Cross compile for Raspberry PI on Windows
* $> https://gnutoolchains.com/raspberry/
* https://gnutoolchains.com/raspberry64/
# Useful URLs
* Rust patterns: https://github.com/rust-unofficial/patterns
* Rust cheat Sheet: https://cheats.rs/
* HTML Validation Service: https://validator.w3.org/
* Site analysis: https://pagespeed.web.dev/
* Open-Source UI: https://uiverse.io/
# Useful tools
HTTP benchmarking and stress tool: https://crates.io/crates/oha
HTTP API tool: https://www.usebruno.com/
GUI Database client: https://dbeaver.io/