Replace endpoint /calendar/schedule_recipe by /calendar/sheduled_recipe

[recipes.git] / README.md

diff --git a/README.md b/README.md
index 120c610..590a690 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,65 @@
-== Autoreload
-
-https://actix.rs/docs/autoreload/
-
-
-== Documentation
-
-* Rust patterns : https://github.com/rust-unofficial/patterns/tree/master/patterns
-* Rusqlite (SQLite) : https://docs.rs/rusqlite/0.20.0/rusqlite/
+# Technical\r
+\r
+## Backend\r
+\r
+### Launch Axum\r
+\r
+In directory '/backend' type:\r
+    $> cargo run\r
+\r
+Then browse http://127.0.0.1:8082 (You need to compile the wasm file first, see section 'Frontend')\r
+\r
+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.\r
+\r
+### Autoreload\r
+\r
+First install cargo watch:\r
+    $> cargo install cargo-watch\r
+\r
+In directory '/backend' type:\r
+    $> cargo watch -x run\r
+\r
+\r
+## Frontend\r
+\r
+### Tools needed\r
+\r
+nushell: https://www.nushell.sh/\r
+trunk: https://trunkrs.dev\r
+\r
+### Compilation\r
+\r
+In directory '/frontend' type:\r
+    $> nu deploy.nu\r
+\r
+It will create the '/frontend/pkg' directory and copy the wasm file into '/backend/static'.\r
+You can now refresh your browser to reload the wasm file.\r
+\r
+# How-to\r
+\r
+## How to install service on a Linux server\r
+\r
+As root:\r
+\r
+1. Copy '/doc/recipes.service' to '/lib/systemd/system/'\r
+2. Enabled it: #> systemctl enable recipes\r
+3. Launch it: #> systemctl start recipes\r
+\r
+## Cross compile for Raspberry PI on Windows\r
+\r
+* $> https://gnutoolchains.com/raspberry/\r
+* https://gnutoolchains.com/raspberry64/\r
+\r
+# Useful URLs\r
+\r
+* Rust patterns: https://github.com/rust-unofficial/patterns\r
+* Rust cheat Sheet: https://cheats.rs/\r
+* HTML Validation Service: https://validator.w3.org/\r
+* Site analysis: https://pagespeed.web.dev/\r
+* Open-Source UI: https://uiverse.io/\r
+\r
+# Useful tools\r
+\r
+HTTP benchmarking and stress tool: https://crates.io/crates/oha\r
+HTTP API tool: https://www.usebruno.com/\r
+GUI Database client: https://dbeaver.io/\r