diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e864446 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2012 Nick Sergeant + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cdfcb01 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# 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. + +# Running the Django app + +1. Clone the repo. +2. Setup a virtualenv. +3. `pip install -r requirements` +4. Copy local_settings-template.py to local_settings.py and edit the settings. +5. Run it! diff --git a/local_settings-template.py b/local_settings-template.py new file mode 100644 index 0000000..893c932 --- /dev/null +++ b/local_settings-template.py @@ -0,0 +1,31 @@ +ADMINS = ( + ('Name', 'name@domain.com'), +) +MANAGERS = ADMINS + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql_psycopg2', + 'NAME': 'snipt', + 'USER': '', + 'PASSWORD': '', + 'HOST': 'localhost', + 'PORT': '', + } +} + +SECRET_KEY = '' + +DEFAULT_FROM_EMAIL = 'support@snipt.net' +SERVER_EMAIL = 'support@snipt.net' +EMAIL_BACKEND = 'postmark.django_backend.EmailBackend' +POSTMARK_API_KEY = '' + +VIRTUALENV_PATH = '' + +AMAZON_API_KEY = '' +AMAZON_API_SECRET = '' + +STRIPE_API_KEY = '' + +ENV_HOST = 'user@domain.com:22'