docs: updated README

This commit is contained in:
theo 2024-05-01 23:02:36 +02:00
parent e1d575bce9
commit ade4a86a74

View File

@ -1,16 +1,31 @@
# clego-app
## Tech Stack
- Rust
- Axum: for serving static assets and powering the backend API
- htmx: for reactivity on the UI
- Maud: HTML templating (debatable, we may want to switch to askama)
- Sass: for styling
- Bulma: no-js css-style framwork
- Bootstrap Icons: for icons
- Grass: for scss compiling
- lightningcss to minify css
- Rust: 🦀
- Axum: for serving static assets and powering the backend API
- htmx: for reactivity on the UI
- Maud: HTML templating (debatable, we may want to switch to askama)
- lightningcss: bundle and minify css
## Font choice
Use default system fonts to enhance native feel as well as lower size, following [Modern Font Stacks](https://github.com/system-fonts/modern-font-stacks)
## Commit messages
See [link](https://www.conventionalcommits.org/fr/v1.0.0/)
## Development Environment
For automatic rebuilds on change install cargo-watch:
```sh
cargo install cargo-watch
```
Then to run it:
```sh
cargo watch -c run
```