snipt/README.md

24 lines
1.1 KiB
Markdown
Raw Normal View History

# Snipt
This is the codebase for the website, [Snipt.net](https://snipt.net/).
It's a relatively well-kept Django app, so you shouldn't have too many problems getting a local copy running.
2013-01-20 16:30:25 -08:00
**Note:** These instructions assume you already have [Git](http://git-scm.com/) and [Mercurial](http://mercurial.selenic.com/) installed.
2012-11-15 08:06:24 -08:00
2012-11-15 08:06:40 -08:00
If you need help, visit `#snipt` on irc.freenode.net.
# Running the Django app
1. Clone the repo.
2. Setup a virtualenv.
2012-10-02 16:09:39 -07:00
3. `pip install -r requirements.txt`
4. `pip install --index-url https://code.stripe.com --upgrade stripe`
5. Copy settings_local-template.py to settings_local.py and edit the settings. Be sure to change the [`SESSION_COOKIE_DOMAIN`](https://github.com/nicksergeant/snipt/blob/master/settings_local-template.py#L58), or authentication won't work.
2013-03-25 18:41:29 -07:00
6. `python manage.py syncdb`
7. `python manage.py migrate`
8. `python manage.py runserver`
2013-10-25 10:49:57 -07:00
9. If you created a superuser in the syncdb step, you need to also run `python manage.py backfill_api_keys` to generate an API key for that user.
2012-09-18 16:36:25 -07:00
Any problems / questions / bugs, [create an issue](https://github.com/nicksergeant/snipt/issues). Thanks! :)