Peter Nixon avatar Peter Nixon committed a9d5827

Add an example project for people who need a quickstart

Comments (0)

Files changed (5)

example/README.rst

+Photolog Example Project
+========================
+
+The 'example' directory contains a ready made Django project that should "just work" in the same way
+that any standard Django app does.
+
+It has two major prerequisites which will need to be installed first however. They are::
+
+1) django
+2) django-imagekit
+
+Firsly, create the database and admin user::
+
+  user@machine:~/django-photolog/example> ./manage.py syncdb
+  Creating table auth_permission
+  Creating table auth_group_permissions
+  Creating table auth_group
+  Creating table auth_user_user_permissions
+  Creating table auth_user_groups
+  Creating table auth_user
+  Creating table auth_message
+  Creating table django_content_type
+  Creating table django_session
+  Creating table django_site
+  Creating table django_admin_log
+  Creating table photolog_gallery_photos
+  Creating table photolog_gallery
+  Creating table photolog_galleryupload
+  Creating table photolog_photo
+
+  You just installed Django's auth system, which means you don't have any superusers defined.
+  Would you like to create one now? (yes/no): yes
+  Username (Leave blank to use 'user'):
+  E-mail address: user@domain.com
+  Password:
+  Password (again):
+  Superuser created successfully.
+  Installing index for auth.Permission model
+  Installing index for auth.Group_permissions model
+  Installing index for auth.User_user_permissions model
+  Installing index for auth.User_groups model
+  Installing index for auth.Message model
+  Installing index for admin.LogEntry model
+  Installing index for photolog.Gallery_photos model
+  Installing index for photolog.GalleryUpload model
+  No fixtures found.
+
+Secondly, run the development web server::
+
+  user@machine:~/django-photolog/example> ./manage.py runserver
+  Validating models...
+  0 errors found
+
+  Django version 1.2.3, using settings 'example.settings'
+  Development server is running at http://127.0.0.1:8000/
+  Quit the server with CONTROL-C.
+
+Thirdly, navigate to http://127.0.0.1:8000/admin/ with your favourite web browser.

Empty file added.

example/manage.py

+#!/usr/bin/env python
+import os, sys
+sys.path.insert(0, os.path.abspath('./..'))
+
+"""manage.py"""
+from django.core.management import execute_manager
+try:
+    import settings # Assumed to be in the same directory.
+except ImportError:
+    import sys
+    sys.stderr.write("Error: Can't find the file 'settings.py' in the directory containing %r. It appears you've customized things.\nYou'll have to run django-admin.py, passing it your settings module.\n(If the file settings.py does indeed exist, it's causing an ImportError somehow.)\n" % __file__)
+    sys.exit(1)
+
+if __name__ == "__main__":
+    execute_manager(settings)

example/settings.py

+# Django settings for example project.
+import os
+
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+BASE_DIR = os.path.dirname(os.path.dirname(__file__))
+BASE_DIR = os.path.abspath(BASE_DIR)
+
+ADMINS = (
+    # ('Your Name', 'your_email@domain.com'),
+)
+
+MANAGERS = ADMINS
+
+DATABASE_ENGINE = 'sqlite3'
+DATABASE_NAME = os.path.join(BASE_DIR, 'example', 'database.sqlite')
+DATABASE_USER = ''             # Not used with sqlite3.
+DATABASE_PASSWORD = ''         # Not used with sqlite3.
+DATABASE_HOST = ''             # Set to empty string for localhost. Not used with sqlite3.
+DATABASE_PORT = ''             # Set to empty string for default. Not used with sqlite3.
+
+# Local time zone for this installation. Choices can be found here:
+# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
+# although not all choices may be available on all operating systems.
+# If running in a Windows environment this must be set to the same as your
+# system time zone.
+TIME_ZONE = 'America/Chicago'
+
+# Language code for this installation. All choices can be found here:
+# http://www.i18nguy.com/unicode/language-identifiers.html
+LANGUAGE_CODE = 'en-us'
+
+SITE_ID = 1
+
+# If you set this to False, Django will make some optimizations so as not
+# to load the internationalization machinery.
+USE_I18N = True
+
+# Absolute path to the directory that holds media.
+# Example: "/home/media/media.lawrence.com/"
+MEDIA_ROOT = ''
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash if there is a path component (optional in other cases).
+# Examples: "http://media.lawrence.com", "http://example.com/media/"
+MEDIA_URL = ''
+
+# URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
+# trailing slash.
+# Examples: "http://foo.com/media/", "/media/".
+ADMIN_MEDIA_PREFIX = '/media/'
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = '-=v_u)0r_u4*x(3aw@hh*sjfguydss+tf*9-k&99t9)b$a+d*'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+    'django.template.loaders.filesystem.load_template_source',
+    'django.template.loaders.app_directories.load_template_source',
+#     'django.template.loaders.eggs.load_template_source',
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.middleware.common.CommonMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+)
+
+ROOT_URLCONF = 'example.urls'
+
+TEMPLATE_DIRS = (
+    # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+)
+
+INSTALLED_APPS = (
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+    'django.contrib.admin',
+    'imagekit',
+    'photolog',
+)
+from django.conf.urls.defaults import *
+
+from django.contrib import admin
+admin.autodiscover()
+
+urlpatterns = patterns('',
+    (r'^photolog/', include('photolog.urls')),
+    (r'^admin/', include(admin.site.urls)),
+)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.