Mercurial > sat_legacy_website

annotate README @ 27:eda4deefecd1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
reorganisation of the menu using submenus
author souliane <souliane@mailoo.org>
date Wed, 21 Jan 2015 20:07:20 +0100
parents 3df49721008c
children b45621706d83
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
1 Salut à Toi's website
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
2 (c) Jérôme Poisson aka Goffi 2012
23
2fdbf8ebb72b upgrade to Django 1.7.3
souliane <souliane@mailoo.org>
parents: 1
diff changeset
3 (c) Adrien Cossa aka Souliane 2015
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
4
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
5 ** LICENCE **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
6
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
7 SàT website is free software: you can redistribute it and/or modify
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
8 it under the terms of the GNU Affero General Public License as
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
9 the Free Software Foundation, either version 3 of the License, or
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
10 (at your option) any later version.
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
11
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
12 SàT website is distributed in the hope that it will be useful,
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
15 GNU Affero General Public License for more details.
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
16
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
17 You should have received a copy of the GNU Affero General Public License
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
18 along with SàT website. If not, see <http://www.gnu.org/licenses/>.
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
19
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
20 ---
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
21
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
22 The third party projects are under compatible licences (see below)
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
23
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
24 ---
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
25
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
26 The media in /static/images and /static/videos comes from Salut à Toi project and are under Creative Commons licence CC By-SA
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
27 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
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
28
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
29 ** ABOUT **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
30
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
31 This is the source code of Salut à Toi's presentation website.
23
2fdbf8ebb72b upgrade to Django 1.7.3
souliane <souliane@mailoo.org>
parents: 1
diff changeset
32 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).
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
33
1
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
34 ** SETTINGS **
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
35
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
36 The following values can be set in site's settings.py:
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
37
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
38 SAT_LINK_PATH = '/path/to/sat_link.tar.bz2' #the link should point to a SàT archive in the form sat-version.tar.bz2
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
39 SAT_DL_PREFIX = 'ftp://ftp.goffi.org/sat' #this prefix will be joined to the filename pointed by the previous link
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
40 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
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
41
23
2fdbf8ebb72b upgrade to Django 1.7.3
souliane <souliane@mailoo.org>
parents: 1
diff changeset
42 Note that the Django application "markdown_deux" ( https://github.com/trentm/django-markdown-deux ) is required.
24
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
43 For more information, check the local_settings.py file which is distributed in the sat_website directory.
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
44
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
45 ** RUNNING THE WEBSITE LOCALLY **
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
46
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
47 This is the basic procedure to run the website on your local machine using the Django built-in web server.
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
48 Please make the difference between the project directory (e.g. ~/workspace/sat_website) and the app directory (e.g. ~/workspace/sat_website/sat_website).
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
49
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
50 First add these two lines to your shell .*rc file:
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
51
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
52 export PYTHONPATH=$PYTHONPATH:<path_to_the_app_directory>
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
53 export DJANGO_SETTINGS_MODULE=settings
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
54
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
55 Create in the app directory a file settings.py containing these lines:
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
56
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
57 try:
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
58 from local_settings import *
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
59 except ImportError:
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
60 pass
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
61
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
62 In the project directory, enter these commands to initialise the website:
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
63
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
64 django-admin syncdb
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
65 django-admin makemessages -a
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
66 django-admin compilemessages
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
67
26
3df49721008c upgrade to Bootstrap v3.3.1
souliane <souliane@mailoo.org>
parents: 24
diff changeset
68 All the preceding 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:
24
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
69
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
70 django-admin runserver
23
2fdbf8ebb72b upgrade to Django 1.7.3
souliane <souliane@mailoo.org>
parents: 1
diff changeset
71
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
72 ** CREDIT **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
73
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
74 The following third party project are shipped with this source code:
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
75
26
3df49721008c upgrade to Bootstrap v3.3.1
souliane <souliane@mailoo.org>
parents: 24
diff changeset
76 - Bootstrap v3.3.1 (http://getbootstrap.com) | Copyright 2011-2014 Twitter, Inc. | MIT licence: https://github.com/twbs/bootstrap/blob/master/LICENSE
3df49721008c upgrade to Bootstrap v3.3.1
souliane <souliane@mailoo.org>
parents: 24
diff changeset
77 - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license
3df49721008c upgrade to Bootstrap v3.3.1
souliane <souliane@mailoo.org>
parents: 24
diff changeset
78 - Partition (http://djangosnippets.org/snippets/401/) | Copyright 2007 Smiley Chris | Custom free (libre) licence: http://djangosnippets.org/about/tos
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
79
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
80 In addition, this project use Django to run.
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
81
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
82 Thanks to the authors/contributors of these projects
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
83
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
84 ** CONTACT **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
85
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
86 Jérôme Poisson
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
87
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
88 e-mail: goffi@goffi.org
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
89 jid: goffi@jabberfr.org
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
90