doc: improve README #43

Merged
pitbuster merged 2 commits from readme into main 2024-07-16 00:25:22 -04:00
2 changed files with 30 additions and 2 deletions
Showing only changes of commit e93e392fff - Show all commits

View file

@ -1,5 +1,11 @@
# Changelog
## [unreleased]
### Miscellaneous Tasks
- Bump dependencies ([#42](https://oolong.ludwig.dog/pitbuster/huellas/issues/42))
## [0.3.0] - 2024-03-07
### Documentation
@ -10,6 +16,10 @@
- [**breaking**] Use msgpack instead of json ([#40](https://oolong.ludwig.dog/pitbuster/huellas/issues/40))
### Miscellaneous Tasks
- 0.3.0 ([#41](https://oolong.ludwig.dog/pitbuster/huellas/issues/41))
## [0.2.3] - 2024-01-19
### Miscellaneous Tasks

View file

@ -1,8 +1,26 @@
# huellas
This service is backed by an Axum server and uses a raw Typescript front-end using
Leaflet.js.
## Migrations
## Development
To run the application locally, just do
```shell
cargo run
```
To compile the front-end code, go to the `ts-client` folder, install the dependencies
with
```shell
npm install
```
and then run
```
make
```
### Install git hooks
Run the following from the project root:
```shell
hooks/install.sh
```
### Migrations
We use the `sqlx` CLI to manage migrations. To create a new one run
```shell
cargo sqlx migrate add