docs: updated README
This commit is contained in:
parent
e1d575bce9
commit
ade4a86a74
29
README.md
29
README.md
@ -1,16 +1,31 @@
|
|||||||
# clego-app
|
# clego-app
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
- Rust
|
|
||||||
|
- Rust: 🦀
|
||||||
- Axum: for serving static assets and powering the backend API
|
- Axum: for serving static assets and powering the backend API
|
||||||
- htmx: for reactivity on the UI
|
- htmx: for reactivity on the UI
|
||||||
- Maud: HTML templating (debatable, we may want to switch to askama)
|
- Maud: HTML templating (debatable, we may want to switch to askama)
|
||||||
- Sass: for styling
|
- lightningcss: bundle and minify css
|
||||||
- Bulma: no-js css-style framwork
|
|
||||||
- Bootstrap Icons: for icons
|
|
||||||
- Grass: for scss compiling
|
|
||||||
- lightningcss to minify css
|
|
||||||
|
|
||||||
|
|
||||||
## Font choice
|
## 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)
|
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
|
||||||
|
```
|
||||||
|
Reference in New Issue
Block a user