Mercurial > sat_legacy_website
annotate README @ 45:62c23067e86e
improve English texts following recommandations from Florian
| author | souliane <souliane@mailoo.org> |
|---|---|
| date | Mon, 27 Apr 2015 16:21:45 +0200 |
| parents | dfe7139dae0a |
| children | 746e53efc188 |
| rev | line source |
|---|---|
| 0 | 1 Salut à Toi's website |
| 2 (c) Jérôme Poisson aka Goffi 2012 | |
| 23 | 3 (c) Adrien Cossa aka Souliane 2015 |
| 0 | 4 |
| 5 ** LICENCE ** | |
| 6 | |
| 7 SàT website is free software: you can redistribute it and/or modify | |
| 8 it under the terms of the GNU Affero General Public License as | |
| 9 the Free Software Foundation, either version 3 of the License, or | |
| 10 (at your option) any later version. | |
| 11 | |
| 12 SàT website is distributed in the hope that it will be useful, | |
| 13 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 GNU Affero General Public License for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU Affero General Public License | |
| 18 along with SàT website. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | |
| 20 --- | |
| 21 | |
| 22 The third party projects are under compatible licences (see below) | |
| 23 | |
| 24 --- | |
| 25 | |
| 26 The media in /static/images and /static/videos comes from Salut à Toi project and are under Creative Commons licence CC By-SA | |
| 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 | |
| 28 | |
| 29 ** ABOUT ** | |
| 30 | |
| 31 This is the source code of Salut à Toi's presentation website. | |
| 23 | 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 | 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 |
| 39 | 38 # External URL pointing the projects archives directory |
| 39 PROJECTS_EXTERNAL_PATH = 'ftp://ftp.goffi.org' | |
| 40 | |
| 41 # Internal path to the projects archives directory | |
| 42 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
|
43 |
| 39 | 44 # List of couples with the project directory name and the project name (set to None if it's the same) |
| 45 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
|
46 |
| 39 | 47 # Extension used to name the project archives |
| 48 ARCHIVE_SUFFIX = '.tar.bz2' | |
|
31
31d196cf3b34
add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents:
29
diff
changeset
|
49 |
|
31d196cf3b34
add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents:
29
diff
changeset
|
50 # URL to Libervia online demo |
|
31d196cf3b34
add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents:
29
diff
changeset
|
51 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
|
52 |
| 39 | 53 # 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
|
54 ASSO_MEMBERS_ACTUAL = 3400 |
|
31d196cf3b34
add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents:
29
diff
changeset
|
55 ASSO_MEMBERS_TARGET = 6000 |
|
31d196cf3b34
add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents:
29
diff
changeset
|
56 |
| 39 | 57 # 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
|
58 ASSO_FINANCE_ACTUAL = 40000 |
|
31d196cf3b34
add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents:
29
diff
changeset
|
59 ASSO_FINANCE_TARGET = 60000 |
|
31d196cf3b34
add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents:
29
diff
changeset
|
60 |
| 39 | 61 # 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
|
62 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
|
63 |
|
40
dfe7139dae0a
add links to the statutes and rules of the association in the adhesion form
souliane <souliane@mailoo.org>
parents:
39
diff
changeset
|
64 # 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
|
65 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
|
66 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
|
67 |
|
1
a49aa1b823f6
added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
68 |
| 23 | 69 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
|
70 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
|
71 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
72 ** RUNNING THE WEBSITE LOCALLY ** |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
73 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
74 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
|
75 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
|
76 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
77 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
|
78 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
79 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
|
80 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
|
81 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
82 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
|
83 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
84 try: |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
85 from local_settings import * |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
86 except ImportError: |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
87 pass |
|
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 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
|
90 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
91 django-admin syncdb |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
92 django-admin makemessages -a |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
93 django-admin compilemessages |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
94 |
| 26 | 95 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
|
96 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
97 django-admin runserver |
| 23 | 98 |
| 0 | 99 ** CREDIT ** |
| 100 | |
| 101 The following third party project are shipped with this source code: | |
| 102 | |
| 26 | 103 - Bootstrap v3.3.1 (http://getbootstrap.com) | Copyright 2011-2014 Twitter, Inc. | MIT licence: https://github.com/twbs/bootstrap/blob/master/LICENSE |
| 104 - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license | |
| 0 | 105 |
| 106 In addition, this project use Django to run. | |
| 107 | |
| 108 Thanks to the authors/contributors of these projects | |
| 109 | |
| 110 ** CONTACT ** | |
| 111 | |
| 112 Jérôme Poisson | |
| 113 | |
| 114 e-mail: goffi@goffi.org | |
| 115 jid: goffi@jabberfr.org | |
| 116 |