-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bfc7f28
commit 900103a
Showing
1 changed file
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,30 @@ | ||
# grout | ||
Geo tile server | ||
Grout serves map tiles (mbtiles) data which can be consumed in web front ends by Leaflet etc. | ||
|
||
## Development | ||
|
||
Grout is implemented as an [express](https://expressjs.com/) server in Typescript. | ||
|
||
Developed with node v22. | ||
|
||
Run in dev mode with hot reloading: `npm run dev` | ||
|
||
Build for production: `npm run build` | ||
|
||
Run in production mode: `npm run prod` | ||
|
||
In both modes, local run is on port 5000. Port is configured in `config/grout.config.json` | ||
|
||
## Tests | ||
|
||
The server needs to be running for the integration tests to pass. | ||
|
||
Run unit and integration tests with `npm run test` | ||
|
||
# Lint | ||
|
||
Run lint with `npm run lint`. To do any possible automatic fixes run `npm run lint-fix`. | ||
|
||
## Docker | ||
See the `docker` folder for Dockerfile and scripts to build, push, run, stop, and push branch tag for the image. The run | ||
script always pulls. The image is pushed to the ghcr.io registry. |