Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to README for easy install #7

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add documentation to README for easy install #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84f23d9
Update README.md with install/setup documentation
heyitsolivia Oct 6, 2015
7b98fd4
update .env.example to work out of the box
heyitsolivia Oct 6, 2015
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
14 changes: 4 additions & 10 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
export SECRET_KEY=dontusethisasyourpassword
export ADMIN_PASSWORD=accesses the settings page
export BASIC_PASSWORD=otherpeoplewillusethis
export DROPBOX_KEY=youllgetthisfromdropbox
export DROPBOX_SECRET=https://www.dropbox.com/developers
export TUMBLR_KEY=youllgetthisfromtuble
export TUMBLR_SECRET=https://www.tumblr.com/docs/en/api/v2
export TUMBLR_HOSTNAME=whereeveryouwanttohost.tumblr.com
export MONGOLAB_URI=youllgetthisfromherokuaddonsifyouwantto
export SECRET_KEY=change_this_password
export ADMIN_PASSWORD=accesses_settings_page
export MONGOLAB_URI=mongodb://localhost/jifbox

echo success!
echo success!
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ JIFBOX is a web-based animated GIF photobooth. GIFs are generated in the browser

Want to see some GIFs generated by JIFBOX? Check out Sunlight Foundation's [Sunfright Tumblr](http://sunfrightgifs.tumblr.com) from our annual Halloween open house.

## Install and Setup
1. Clone this repo and `cd` into the directory.
2. Create a virtual environment. (If you have [virtualenvwrapper](https://virtualenvwrapper.readthedocs.org) you can run `mkvirtualenv jifbox`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(then 'workon jifbox')

3. Run `pip install -r requirements.txt` to install dependencies.
4. Run `cp .env.example .env` to make your own copy of the .env file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(with your own credentials). I would also put in a bit about getting mongo up and running here.

5. Run `source .env` to load environment variables.
5. Make sure MongoDB is running. If you don't have MongoDB, install it using `brew install mongodb` or follow [these instructions to install and run MongoDB on your OS](https://docs.mongodb.org/manual/installation/#installation-guides).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, we had issues running a local instance of mongo. I found it easier to set up a mongolab account.

6. Run `python web.py` to start up the server
7. Open `http://localhost:8000` in your browser.

## Deploy

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/sunlightlabs/jifbox)
Expand Down Expand Up @@ -55,4 +65,4 @@ Basic app configuration is done via environment variables. Additional settings f
| DROPBOX_SECRET | App secret from the [Dropbox App Console](https://www.dropbox.com/developers/apps) |
| TUMBLR_KEY | Consumer key for the [Tumblr API](https://www.tumblr.com/oauth/apps) |
| TUMBLR_SECRET | Consumer secret for the [Tumblr API](https://www.tumblr.com/oauth/apps) |
| TUMBLR_HOSTNAME | Full hostname for your Tumblr blog (ex: *this-is-my-blog.tumblr.com*) |
| TUMBLR_HOSTNAME | Full hostname for your Tumblr blog (ex: *this-is-my-blog.tumblr.com*) |