From 84f23d9837662c3956b5b2c71dbfe81c774942c4 Mon Sep 17 00:00:00 2001 From: Olivia Cheng Date: Tue, 6 Oct 2015 17:46:11 -0400 Subject: [PATCH 1/2] Update README.md with install/setup documentation --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d8e2944..565218f 100644 --- a/README.md +++ b/README.md @@ -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`) +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. +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). +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) @@ -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*) | \ No newline at end of file +| TUMBLR_HOSTNAME | Full hostname for your Tumblr blog (ex: *this-is-my-blog.tumblr.com*) | From 7b98fd4c52267a873001e8a736863e603af58e58 Mon Sep 17 00:00:00 2001 From: Olivia Cheng Date: Tue, 6 Oct 2015 17:53:36 -0400 Subject: [PATCH 2/2] update .env.example to work out of the box --- .env.example | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/.env.example b/.env.example index 39b47d9..9e37771 100644 --- a/.env.example +++ b/.env.example @@ -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! \ No newline at end of file +echo success!