Mercurial > sat_legacy_website
annotate README @ 60:0d20fb28c32e
many small changes:
- set opacity 0.85 to libervia screenshot on the main page
- remove videos from the repository (stored on external ftp)
- more details in the README concerning the i18n
- settings can be overriden by an external file (for the stats)
- add in basic features.html a button to experimental features
- add a link to the SàT MUC in downloads section
- add link to bugzilla + improve other links in dev/community
- add + symbol for projects using standard blogging system
- add ~ symbol for projects being no communication tool
- save subscription form results to a text file
- update press.py and links.py
| author | souliane <souliane@mailoo.org> |
|---|---|
| date | Fri, 15 May 2015 17:15:40 +0200 |
| parents | 746e53efc188 |
| children | 1fb1e233d63f |
| 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 |
|
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 | 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 | 43 |
| 44 # Internal path to the projects archives directory | |
| 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 | 47 # List of couples with the project directory name and the project name (set to None if it's the same) |
| 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 | 50 # Extension used to name the project archives |
| 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 | 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 | 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 | 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 |
| 60 | 67 # Path the CSV file where all the subscriptions are written |
| 68 ASSO_SUBSCR_CSV = "/home/souliane/sat_website_subscriptions.csv" | |
| 69 | |
|
58
746e53efc188
allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents:
40
diff
changeset
|
70 # Bank account information |
|
746e53efc188
allow large media files (screencasts) to be stored on an external server
souliane <souliane@mailoo.org>
parents:
40
diff
changeset
|
71 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
|
72 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
|
73 |
|
40
dfe7139dae0a
add links to the statutes and rules of the association in the adhesion form
souliane <souliane@mailoo.org>
parents:
39
diff
changeset
|
74 # 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
|
75 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
|
76 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
|
77 |
| 60 | 78 # Import another settings file that can override these settings (for example to daily update the stats when you don't want a script to directly modify this file) |
| 79 from sys import path | |
| 80 path.append('/home/souliane') | |
| 81 from sat_website_external_settings import * | |
|
1
a49aa1b823f6
added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
82 |
| 23 | 83 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
|
84 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
|
85 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
86 ** RUNNING THE WEBSITE LOCALLY ** |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
87 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
88 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
|
89 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
|
90 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
91 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
|
92 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
93 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
|
94 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
|
95 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
96 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
|
97 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
98 try: |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
99 from local_settings import * |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
100 except ImportError: |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
101 pass |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
102 |
| 60 | 103 In the project directory, enter this command to initialise the website (this has to be done only once): |
|
24
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
104 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
105 django-admin syncdb |
| 60 | 106 |
| 107 If you modify some strings in the Django code, update the i18n .po files with: | |
| 108 | |
|
24
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
109 django-admin makemessages -a |
| 60 | 110 |
| 111 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): | |
| 112 | |
|
24
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
113 django-admin compilemessages |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
114 |
| 60 | 115 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
|
116 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
117 django-admin runserver |
| 23 | 118 |
| 0 | 119 ** CREDIT ** |
| 120 | |
| 121 The following third party project are shipped with this source code: | |
| 122 | |
| 26 | 123 - Bootstrap v3.3.1 (http://getbootstrap.com) | Copyright 2011-2014 Twitter, Inc. | MIT licence: https://github.com/twbs/bootstrap/blob/master/LICENSE |
| 124 - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license | |
| 0 | 125 |
| 126 In addition, this project use Django to run. | |
| 127 | |
| 128 Thanks to the authors/contributors of these projects | |
| 129 | |
| 130 ** CONTACT ** | |
| 131 | |
| 132 Jérôme Poisson | |
| 133 | |
| 134 e-mail: goffi@goffi.org | |
| 135 jid: goffi@jabberfr.org | |
| 136 |