huellas/README.md
Felipe Contreras Salinas 9b529cedb4
doc: improve README (#43)
Reviewed-on: #43
Co-authored-by: Felipe Contreras Salinas <felipe@bstr.cl>
Co-committed-by: Felipe Contreras Salinas <felipe@bstr.cl>
2024-07-16 00:25:20 -04:00

32 lines
725 B
Markdown

# huellas
This service is backed by an Axum server and uses a raw Typescript front-end using
Leaflet.js.
## 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
```
## Cross-architecture building
Images are built for arm64 on a juicier machine using
```shell
docker buildx build --platform=linux/arm64 . -t oolong.ludwig.dog/pitbuster/huellas:X.Y.Z
```