martin/README.md

45 lines
1.0 KiB
Markdown
Raw Normal View History

2018-01-16 15:55:05 +03:00
# Martin
2017-10-09 14:29:03 +03:00
2018-10-05 17:58:06 +03:00
![CircleCI](https://img.shields.io/circleci/project/github/urbica/martin.svg?style=popout)
2017-10-15 14:48:23 +03:00
2018-08-25 15:45:04 +03:00
Martin is a PostGIS [Mapbox Vector Tiles](https://github.com/mapbox/vector-tile-spec) server written in Rust using [Actix](https://github.com/actix/actix-web) web framework.
2017-10-09 14:29:03 +03:00
**Warning: this is experimental**
## Installation
2018-01-16 15:55:05 +03:00
git clone git@github.com:urbica/martin.git
cd martin
2017-10-09 14:29:03 +03:00
cargo build --release
2018-01-16 15:55:05 +03:00
./target/release/martin
2017-10-09 14:29:03 +03:00
## Usage
2018-10-05 14:52:53 +03:00
DATABASE_URL=postgres://postgres@localhost:5432/db martin
2017-10-09 14:29:03 +03:00
2018-03-27 14:40:33 +03:00
## Environment variables
DATABASE_URL
DATABASE_POOL_SIZE
WORKER_PROCESSES
KEEP_ALIVE
2017-10-09 14:29:03 +03:00
## Using with Docker
2018-10-01 20:10:33 +03:00
docker run -d --rm --name postgres \
-p 5432:5432 \
-e POSTGRES_PASSWORD=password \
2018-10-05 14:52:53 +03:00
mdillon/postgis:11-alpine
2018-10-01 20:10:33 +03:00
docker run -d --rm --name martin \
2017-10-09 14:29:03 +03:00
-p 3000:3000 \
-e DATABASE_URL=postgres://postgres:password@localhost:5432/test \
2018-01-16 15:55:05 +03:00
urbica/martin
2017-10-09 14:29:03 +03:00
## Development
Install project dependencies and check that the tests run
cargo test
cargo run