From 9435fd7e9ce96ec0caf884d6dacfdf04dff65a59 Mon Sep 17 00:00:00 2001 From: Stepan Kuzmin Date: Sun, 20 Dec 2020 14:34:03 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20=20update=20README?= =?UTF-8?q?.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dbe287e83..f43597ed0 100755 --- a/README.md +++ b/README.md @@ -468,9 +468,29 @@ martin postgres://postgres@localhost/db ## Development -Install project dependencies and check if all the tests are running. +Clone project ```shell -cargo test -cargo run +git clone git@github.com:urbica/martin.git +cd martin +``` + +Start `db` service using [docker-compose](https://docs.docker.com/compose/) + +```shell +docker-compose up -d db +``` + +Then, after `db` service is ready to accept connections, you can start `martin` with + +```shell +DATABASE_URL=postgres://postgres@localhost/db cargo run +``` + +By default, martin will be available at [localhost:3000](http://localhost:3000/index.json) + +Make your changes, and check if all the tests are running + +```shell +DATABASE_URL=postgres://postgres@localhost/db cargo test ```