Skip to content

Commit

Permalink
Added documentation for devs.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobSpectre committed Jan 3, 2012
1 parent 750c1b7 commit 987b88d
Showing 1 changed file with 58 additions and 2 deletions.
60 changes: 58 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,73 @@ Or go to the [website](http://www.somethinginmyring.com).

### Installation

Clone repo and hack on as any [Flask](http://flask.pocoo.org/) application.
Requires Python 2.5 or greater.

1. Clone repo:

<pre>
git clone git@github.com:RobSpectre/Somebody-Put-Something-In-My-Ring.git
</pre>

2. Install dependencies:

<pre>
cd Somebody-Put-Something-In-My-Ring
pip install -r requirements.txt
</pre>

3. Login to [Twilio](https://www.twilio.com/login) (or [signup for
account](https://www.twilio.com/try-twilio?g=)).

4. [Create new TwiML App](https://www.twilio.com/user/account/apps/add) for Somebody Put Something In My Ring.

5. Configure local_settings.py with your Twilio account details or use
environment variables.

<pre>
export ACCOUNT_SID='ACxxxxxxxxxxxxxxxxx'
export AUTH_TOKEN='yyyyyyyyyyyyyyyyyyyy'
export RAMONES_APP_SID='APzzzzzzzzzzzzz'
export RAMONES_CALLER_ID='+17778889999'
</pre>

6. Launch dev server.

<pre>
python web.py
</pre>

Note - a Procfile is included if you would prefer to use Foreman.

### Structure

* app.py - Core Flask app.
* templates/index.html - Main webpage with [Twilio Client](http://www.twilio.com/api/client) integration.
* static/ - Root of all static files, including JS and CSS.

### Deployment

This app is currently running on [Heroku](http://www.heroku.com), but can be
deployed to any WSGI compliant hosting provider. If it runs Python, it should
be able to run this project.

### Testing

Use nose or simply run from root:

<pre>
python tests/
python tests
</pre>


## Technologies

* [Flask](http://flask.pocoo.org/) - Python microframework. Makes all this go.
* [Skeleton](http://www.getskeleton.com) - Easy CSS framework for responsive design (resize the browser window and marvel!)
* [Heroku](http://www.heroku.com) - Uber easy cloud hosting for Python (and lesser) apps.
* [Twilio](http://www.twilio.com), of course.


## Credits

* License: [Mozilla Public License](http://www.mozilla.org/MPL/)
Expand Down

0 comments on commit 987b88d

Please sign in to comment.