diff --git a/CHANGELOG.md b/CHANGELOG.md index 9770925..e785726 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 34dadbf..7d70bab 100644 --- a/README.md +++ b/README.md @@ -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