Mercurial > sat_legacy_website
view README @ 67:ae46991a3489
English correction (typos and improvements) by Florian and Rachelle
author | souliane <souliane@mailoo.org> |
---|---|
date | Tue, 26 May 2015 21:23:56 +0200 |
parents | 1fb1e233d63f |
children | c1b77f07f644 |
line wrap: on
line source
Salut à Toi's website (c) Jérôme Poisson aka Goffi 2012 (c) Adrien Cossa aka Souliane 2015 ** LICENCE ** SàT website is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as the Free Software Foundation, either version 3 of the License, or (at your option) any later version. SàT website is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with SàT website. If not, see <http://www.gnu.org/licenses/>. --- The third party projects are under compatible licences (see below) --- The media in /static/images and /static/videos comes from Salut à Toi project and are under Creative Commons licence CC By-SA The media in /static/css comes from Twitter Boostrap (see below) and are under Apache licence 2.0, except sat_website.css which is under AGPL v3 ** ABOUT ** This is the source code of Salut à Toi's presentation website. Salut à Toi is a communication software base on XMPP. You can have more informations on http://salut-a-toi.org (the website ran by this code). ** REQUIREMENTS ** To run the website you need: - Django 1.7.3 or superior ( https://www.djangoproject.com ) - Django application "markdown_deux" ( https://github.com/trentm/django-markdown-deux ) ** SETTINGS ** Please check the local_settings.py file which is distributed in the sat_website directory. This is a template describing and initialising all settings. ** 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 You can overwrite settings in settings.py after these lines. In the project directory, enter this command to initialise the website (this has to be done only once): django-admin syncdb If you modify some strings in the Django code, update the i18n .po files with: django-admin makemessages -a After having completed your translations or after a pull from the repository, compile the .po files to their .mo equivalents (the later ones are not stored on the repository): django-admin compilemessages Whenever you want to launch the web server: django-admin runserver You can also specify the interface and port, for example: django-admin runserver 192.168.2.1:8000 ** CREDIT ** The following third party project are shipped with this source code: - Bootstrap v3.3.1 (http://getbootstrap.com) | Copyright 2011-2014 Twitter, Inc. | MIT licence: https://github.com/twbs/bootstrap/blob/master/LICENSE - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license In addition, this project uses Django to run. Thanks to the authors/contributors of these projects ** CONTACT ** Jérôme Poisson e-mail: goffi@goffi.org jid: goffi@jabberfr.org