Skip to content

Commit

Permalink
Tweak instructions based on first round of feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
jaclynperrone committed May 6, 2015
1 parent cfe1c8b commit f110569
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Dependencies:

### 1. Install Dependencies

This is for a Mac install. Other OSs will have similar procedures (using e.g. apt-get or yum).

```bash
brew install Python #brew will install the latest Python 2.7.9, which includes pip
brew install postgres
Expand All @@ -23,27 +25,25 @@ pip install virtualenv

```bash
virtualenv venv # Initialize a new virtual environment.
source venv/bin/activate # Activate your virtual environment. This is the only command you will need to run every time you start the app.
source venv/bin/activate # Activate your virtual environment.
pip install -r requirements.txt # Install python requirements into virtualenv
npm install # Install JS requirements and packages in package.json
npm install # Install JS requirements from package.json
make initenv # Initialize environment file.
$EDITOR ENV.sh # Fill in values. (see next step)
$EDITOR ENV.sh # Fill in values. (see Step #3)
```

After the initial setup, the only command you'll need to run is:
```
source venv/bin/activate
```


### 3. Edit the ENV.sh file (generated by `make initenv`)
### 3. Create your ENV.sh file

Environment variables which must be exported--edit them in the ENV.sh file make
made for you.
You will need to generate an ENV.sh file using 'make initenv'. ENV.sh contains environment variables that need to be exported. You may need to tweak some settings for your installation.

This comment has been minimized.

Copy link
@danvk

danvk May 6, 2015

Contributor

ENV.sh → ENV.sh

This comment has been minimized.

Copy link
@jaclynperrone

jaclynperrone May 6, 2015

Author Contributor

Got it!


```
export PORT=5000
export DATABASE_URI=postgres:///cycledash'
export CELERY_BACKEND='db+sqlite:///celery.db'
export CELERY_BROKER='amqp://localhost'
export WEBHDFS_USER=username
export WEBHDFS_URL=http://example.com:5000
export TYPEKIT_URL="yourtypekitURLwithfontsincluded"
make initenv
```


Expand All @@ -56,7 +56,6 @@ On OS X, setting up and running psql might look like this:
```bash
postgres -D /usr/local/var/postgres
createdb cycledash
psql cycledash
psql cycledash < schema.sql # This loads the schema
```

Expand All @@ -67,7 +66,8 @@ You can iterate more quickly on JavaScript with the following:

```
npm install gulp -g # Make sure you have gulp installed.
gulp # Compile the JS and start the automatic compiler and live-reloader.
gulp # Compile the JS and start the automatic
# compiler and live-reloader.

This comment has been minimized.

Copy link
@danvk

danvk May 6, 2015

Contributor

try to line up the comment with the previous line

This comment has been minimized.

Copy link
@jaclynperrone

jaclynperrone May 6, 2015

Author Contributor

Thanks! Changed the tabs to spaces.

```

Expand Down Expand Up @@ -103,7 +103,8 @@ gulp prod

### 7. Run RabbitMQ (and keep it running)

To test the workers locally, you'll need to install and run rabbitmq during development. For example, on Mac OS X, you can do this via:
To test the workers locally, you'll need to install and run rabbitmq
during development. For example, on Mac OS X, you can do this via:

```
/usr/local/opt/rabbitmq/sbin/rabbitmq-server
Expand Down

0 comments on commit f110569

Please sign in to comment.