Skip to content

Commit

Permalink
docs: ✏️ update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stepankuzmin committed Dec 20, 2020
1 parent 308383a commit 9435fd7
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit 9435fd7

Please sign in to comment.