Mercurial > sat_legacy_website
annotate README @ 113:b96dbc7b6c61
use of “libre” in english version is replaced by “free (libre)” or “free (as in freedom)” to avoid miscomprehension
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 17 Oct 2015 18:54:31 +0200 |
| parents | c1b77f07f644 |
| children | b1c16cd53b62 |
| 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 |
| 64 | 5 |
| 0 | 6 ** LICENCE ** |
| 7 | |
| 8 SàT website is free software: you can redistribute it and/or modify | |
| 9 it under the terms of the GNU Affero General Public License as | |
| 10 the Free Software Foundation, either version 3 of the License, or | |
| 11 (at your option) any later version. | |
| 12 | |
| 13 SàT website is distributed in the hope that it will be useful, | |
| 14 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 16 GNU Affero General Public License for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU Affero General Public License | |
| 19 along with SàT website. If not, see <http://www.gnu.org/licenses/>. | |
| 20 | |
| 21 --- | |
| 22 | |
| 23 The third party projects are under compatible licences (see below) | |
| 24 | |
| 25 --- | |
| 26 | |
| 27 The media in /static/images and /static/videos comes from Salut à Toi project and are under Creative Commons licence CC By-SA | |
| 28 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 | |
| 29 | |
| 64 | 30 |
| 0 | 31 ** ABOUT ** |
| 32 | |
| 33 This is the source code of Salut à Toi's presentation website. | |
| 23 | 34 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 | 35 |
| 64 | 36 |
| 37 ** REQUIREMENTS ** | |
| 38 | |
| 39 To run the website you need: | |
| 40 | |
| 41 - Django 1.7.3 or superior ( https://www.djangoproject.com ) | |
| 42 - Django application "markdown_deux" ( https://github.com/trentm/django-markdown-deux ) | |
|
94
c1b77f07f644
replace shipped file unicodecsv.py with the module of the same name
souliane <souliane@mailoo.org>
parents:
64
diff
changeset
|
43 - Python module unicodecsv ( https://github.com/jdunck/python-unicodecsv ) |
| 64 | 44 |
|
1
a49aa1b823f6
added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
45 ** SETTINGS ** |
|
a49aa1b823f6
added SàT archive download link (detect the last version)
Goffi <goffi@goffi.org>
parents:
0
diff
changeset
|
46 |
| 64 | 47 Please check the local_settings.py file which is distributed in the sat_website directory. |
| 48 This is a template describing and initialising all settings. | |
|
31
31d196cf3b34
add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents:
29
diff
changeset
|
49 |
|
24
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
50 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
51 ** RUNNING THE WEBSITE LOCALLY ** |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
52 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
53 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
|
54 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
|
55 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
56 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
|
57 |
| 64 | 58 export PYTHONPATH=$PYTHONPATH:<path_to_the_app_directory> |
| 59 export DJANGO_SETTINGS_MODULE=settings | |
|
24
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
60 |
|
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
61 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
|
62 |
| 64 | 63 try: |
| 64 from local_settings import * | |
| 65 except ImportError: | |
| 66 pass | |
|
24
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
67 |
| 64 | 68 You can overwrite settings in settings.py after these lines. |
| 60 | 69 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
|
70 |
| 64 | 71 django-admin syncdb |
| 60 | 72 |
| 73 If you modify some strings in the Django code, update the i18n .po files with: | |
| 74 | |
| 64 | 75 django-admin makemessages -a |
| 60 | 76 |
| 77 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): | |
| 78 | |
| 64 | 79 django-admin compilemessages |
|
24
c6a3ca0429dd
add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents:
23
diff
changeset
|
80 |
| 60 | 81 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
|
82 |
| 64 | 83 django-admin runserver |
| 84 | |
| 85 You can also specify the interface and port, for example: | |
| 86 | |
| 87 django-admin runserver 192.168.2.1:8000 | |
| 88 | |
| 23 | 89 |
| 0 | 90 ** CREDIT ** |
| 91 | |
| 92 The following third party project are shipped with this source code: | |
| 93 | |
| 26 | 94 - Bootstrap v3.3.1 (http://getbootstrap.com) | Copyright 2011-2014 Twitter, Inc. | MIT licence: https://github.com/twbs/bootstrap/blob/master/LICENSE |
| 95 - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license | |
| 0 | 96 |
| 64 | 97 In addition, this project uses Django to run. |
| 0 | 98 |
| 99 Thanks to the authors/contributors of these projects | |
| 100 | |
| 64 | 101 |
| 0 | 102 ** CONTACT ** |
| 103 | |
| 104 Jérôme Poisson | |
| 105 | |
| 106 e-mail: goffi@goffi.org | |
| 107 jid: goffi@jabberfr.org | |
| 108 |