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

Update README to use pipenv #4

Merged
merged 1 commit into from
May 20, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.