diff --git a/README.md b/README.md index 81b94db..0416d15 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ **Recipes** is a multi-user website to manage and publish cooking recipes. -# Technical +# Prerequisite -## Backend +* Rust: https://www.rust-lang.org/ +* Trunk: https://trunkrs.dev/ +* Nushell: https://www.nushell.sh/ +* Sass: https://sass-lang.com/ -### Launch Axum +# Launch in debug mode -In directory */backend* type: +```$> nu do.nu run``` -```$> cargo run``` +Then browse http://127.0.0.1:8082 -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. -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 +## Autoreload First install cargo watch: @@ -24,22 +25,6 @@ In directory */backend* type: ```$> cargo watch -x run``` - -## Frontend - -### Tools needed - -trunk: https://trunkrs.dev - -### Compilation - -In directory */frontend* type: - -```$> trunk build``` - -It will create the wasm file in */backend/static*. -You can now refresh your browser to reload the wasm file. - # How-to ## How to install service on a Linux server (with *systemd*) @@ -66,7 +51,6 @@ As root: # Useful tools -* nushell (.nu scripts): https://www.nushell.sh/ * HTTP benchmarking and stress tool: https://crates.io/crates/oha * HTTP API tool: https://www.usebruno.com/ * GUI Database client: https://dbeaver.io/