Mercurial > sat_legacy_website

annotate README @ 59:01738ae70f2d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add poezio and biboumi to the links section
author souliane <souliane@mailoo.org>
date Thu, 14 May 2015 23:42:25 +0200
parents 746e53efc188
children 0d20fb28c32e
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
58
746e53efc188 allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents: 40
diff changeset
38 # External URL pointing the external media files
746e53efc188 allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents: 40
diff changeset
39 MEDIA_EXTERNAL_URL = 'ftp://ftp.goffi.org/media'
746e53efc188 allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents: 40
diff changeset
40
39
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
41 # External URL pointing the projects archives directory
58
746e53efc188 allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents: 40
diff changeset
42 PROJECTS_EXTERNAL_URL = 'ftp://ftp.goffi.org'
39
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
43
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
44 # Internal path to the projects archives directory
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
45 PROJECTS_INTERNAL_PATH = '/var/www/projects'
31
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
46
39
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
47 # List of couples with the project directory name and the project name (set to None if it's the same)
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
48 PROJECTS_NAMES = [('sat', None), ('sat_media', None), ('urwid-satext', 'urwid_satext'), ('sat_pubsub', None), ('libervia', None)]
31
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
49
39
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
50 # Extension used to name the project archives
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
51 ARCHIVE_SUFFIX = '.tar.bz2'
31
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
52
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
53 # URL to Libervia online demo
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
54 LIBERVIA_DEMO_URL = 'https://www.libervia.org'
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
55
39
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
56 # Actual and target number of members
31
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
57 ASSO_MEMBERS_ACTUAL = 3400
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
58 ASSO_MEMBERS_TARGET = 6000
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
59
39
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
60 # Actual and target amount to finance the association (in euros)
31
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
61 ASSO_FINANCE_ACTUAL = 40000
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
62 ASSO_FINANCE_TARGET = 60000
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
63
39
d2c45f4ba57e add downloads.html
souliane <souliane@mailoo.org>
parents: 31
diff changeset
64 # Subscription amounts as defined in the Rules of Procedure
31
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
65 ASSO_SUBSCR_AMOUNTS = (0, 10, 20, 30, 50, 80, 100)
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
66
58
746e53efc188 allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents: 40
diff changeset
67 # Bank account information
746e53efc188 allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents: 40
diff changeset
68 ASSO_IBAN = u"FR76 1027 8060 4300 0207 3220 109"
746e53efc188 allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents: 40
diff changeset
69 ASSO_BIC = u"CMCIFR2A"
746e53efc188 allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents: 40
diff changeset
70
40
dfe7139dae0a add links to the statutes and rules of the association in the adhesion form
souliane <souliane@mailoo.org>
parents: 39
diff changeset
71 # URL to the Statutes and Rules of the association
dfe7139dae0a add links to the statutes and rules of the association in the adhesion form
souliane <souliane@mailoo.org>
parents: 39
diff changeset
72 ASSO_URL_STATUTES = 'http://repos.goffi.org/sat_docs/raw-file/tip/association/statuts.pdf'
dfe7139dae0a add links to the statutes and rules of the association in the adhesion form
souliane <souliane@mailoo.org>
parents: 39
diff changeset
73 ASSO_URL_RULES = 'http://repos.goffi.org/sat_docs/raw-file/tip/association/r%C3%A8glement%20int%C3%A9rieur.pdf'
dfe7139dae0a add links to the statutes and rules of the association in the adhesion form
souliane <souliane@mailoo.org>
parents: 39
diff changeset
74
1
a49aa1b823f6 added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents: 0
diff changeset
75
23
2fdbf8ebb72b upgrade to Django 1.7.3
souliane <souliane@mailoo.org>
parents: 1
diff changeset
76 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
77 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
78
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
79 ** RUNNING THE WEBSITE LOCALLY **
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
80
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
81 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
82 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
83
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
84 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
85
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
86 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
87 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
88
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
89 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
90
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
91 try:
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
92 from local_settings import *
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
93 except ImportError:
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
94 pass
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
95
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
96 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
97
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
98 django-admin syncdb
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
99 django-admin makemessages -a
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
100 django-admin compilemessages
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
101
26
3df49721008c upgrade to Bootstrap v3.3.1
souliane <souliane@mailoo.org>
parents: 24
diff changeset
102 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
103
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
104 django-admin runserver
23
2fdbf8ebb72b upgrade to Django 1.7.3
souliane <souliane@mailoo.org>
parents: 1
diff changeset
105
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
106 ** CREDIT **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
107
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
108 The following third party project are shipped with this source code:
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
109
26
3df49721008c upgrade to Bootstrap v3.3.1
souliane <souliane@mailoo.org>
parents: 24
diff changeset
110 - 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
111 - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
112
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
113 In addition, this project use Django to run.
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
114
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
115 Thanks to the authors/contributors of these projects
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
116
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
117 ** CONTACT **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
118
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
119 Jérôme Poisson
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
120
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
121 e-mail: goffi@goffi.org
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
122 jid: goffi@jabberfr.org
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
123