doc: improve README #43
2 changed files with 30 additions and 2 deletions
10
CHANGELOG.md
10
CHANGELOG.md
|
|
@ -1,5 +1,11 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [unreleased]
|
||||||
|
|
||||||
|
### Miscellaneous Tasks
|
||||||
|
|
||||||
|
- Bump dependencies ([#42](https://oolong.ludwig.dog/pitbuster/huellas/issues/42))
|
||||||
|
|
||||||
## [0.3.0] - 2024-03-07
|
## [0.3.0] - 2024-03-07
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
@ -10,6 +16,10 @@
|
||||||
|
|
||||||
- [**breaking**] Use msgpack instead of json ([#40](https://oolong.ludwig.dog/pitbuster/huellas/issues/40))
|
- [**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
|
## [0.2.3] - 2024-01-19
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
### Miscellaneous Tasks
|
||||||
|
|
|
||||||
22
README.md
22
README.md
|
|
@ -1,8 +1,26 @@
|
||||||
# huellas
|
# huellas
|
||||||
This service is backed by an Axum server and uses a raw Typescript front-end using
|
This service is backed by an Axum server and uses a raw Typescript front-end using
|
||||||
Leaflet.js.
|
Leaflet.js.
|
||||||
|
## Development
|
||||||
## Migrations
|
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
|
We use the `sqlx` CLI to manage migrations. To create a new one run
|
||||||
```shell
|
```shell
|
||||||
cargo sqlx migrate add
|
cargo sqlx migrate add
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue