Skip to content
This repository has been archived by the owner on Feb 29, 2020. It is now read-only.

Commit

Permalink
Merge pull request #4 from okrahealth/update-readme
Browse files Browse the repository at this point in the history
Update README to use pipenv
  • Loading branch information
tbonza authored May 20, 2019
2 parents f862773 + faefe32 commit 7c527f3
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# Okra API

RESTful API for okra.
RESTful API for okra.

## Setup and Installation (for development)

### Step 1: Configure pipenv

- Follow the instructions in the [pipenv README](https://github.com/pypa/pipenv/blob/master/README.md) to install pipenv on your system

### Step 2: Install dependencies

```shell
pipenv install
python setup.py install
```

### Step 3: Start pipenv shell

```shell
pipenv shell
```

This will spawn a new shell subprocess, which can be deactivated by using exit.

0 comments on commit 7c527f3

Please sign in to comment.