changeset 24:c6a3ca0429dd

add local_settings.py and instructions to run the website locally
author souliane <souliane@mailoo.org>
date Sat, 17 Jan 2015 21:37:19 +0100
parents 2fdbf8ebb72b
children 930e73ea9e8e
files README sat_website/local_settings.py
diffstat 2 files changed, 130 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README	Sat Jan 17 21:36:25 2015 +0100
+++ b/README	Sat Jan 17 21:37:19 2015 +0100
@@ -40,6 +40,34 @@
 	SAT_DL_PATH = 'ftp://ftp.goffi.org/sat/sat.tar.bz2' #if set, this link will be used instead of the joined dl_prefix + filename
 
 Note that the Django application "markdown_deux" ( https://github.com/trentm/django-markdown-deux ) is required.
+For more information, check the local_settings.py file which is distributed in the sat_website directory.
+
+** RUNNING THE WEBSITE LOCALLY **
+
+This is the basic procedure to run the website on your local machine using the Django built-in web server.
+Please make the difference between the project directory (e.g. ~/workspace/sat_website) and the app directory (e.g. ~/workspace/sat_website/sat_website).
+
+First add these two lines to your shell .*rc file:
+
+export PYTHONPATH=$PYTHONPATH:<path_to_the_app_directory>
+export DJANGO_SETTINGS_MODULE=settings
+
+Create in the app directory a file settings.py containing these lines:
+
+try:
+    from local_settings import *
+except ImportError:
+    pass
+
+In the project directory, enter these commands to initialise the website:
+
+django-admin syncdb
+django-admin makemessages -a
+django-admin compilemessages
+
+All the preceeding instructions had to be done just once, now you only need to type this command (again in the project directory) whenever you want to launch the web server:
+
+django-admin runserver
 
 ** CREDIT **
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sat_website/local_settings.py	Sat Jan 17 21:37:19 2015 +0100
@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+"""
+Django LOCAL settings for sat_website project, typically to be imported from
+the main settings.py file (see http://stackoverflow.com/a/4909964).
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.7/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.7/ref/settings/
+"""
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+import os
+BASE_DIR = os.path.dirname(os.path.dirname(__file__))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.7/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = '{{ secret_key }}'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+TEMPLATE_DEBUG = DEBUG
+
+
+# Application definition
+
+INSTALLED_APPS = (
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'markdown_deux',  # https://github.com/trentm/django-markdown-deux
+    'sat_website',  # needed to load the apps in templatetags
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.locale.LocaleMiddleware',  # after SessionMiddleWare AND before CommonMiddleWare
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+ROOT_URLCONF = 'sat_website.urls'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.7/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.7/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'Europe/Paris'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+LOCALE_PATHS = ("locale",)
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.7/howto/static-files/
+
+STATIC_URL = '/static/'
+
+STATICFILES_DIRS = (
+    os.path.join(BASE_DIR, 'static'),
+)
+
+# Templates
+
+TEMPLATE_DIRS = (
+    os.path.join(BASE_DIR, 'templates'),
+)
+
+# Options for SàT website (see README)
+
+SAT_LINK_PATH = '/srv/ftp/sat/sat.tar.bz2'
+SAT_DL_PREFIX = 'ftp://ftp.goffi.org/sat'
+#SAT_DL_PATH = 'ftp://ftp.goffi.org/sat/sat.tar.bz2'