Mercurial > sat_legacy_website

annotate README @ 152:1801236f27f0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update deploy.sh
author souliane <souliane@mailoo.org>
date Mon, 30 Oct 2017 23:39:09 +0100
parents b1c16cd53b62
children
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
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
5
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
6 ** LICENCE **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
7
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
8 SàT website is free software: you can redistribute it and/or modify
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
9 it under the terms of the GNU Affero General Public License as
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
10 the Free Software Foundation, either version 3 of the License, or
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
11 (at your option) any later version.
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
12
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
13 SàT website is distributed in the hope that it will be useful,
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
16 GNU Affero General Public License for more details.
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
17
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
18 You should have received a copy of the GNU Affero General Public License
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
19 along with SàT website. If not, see <http://www.gnu.org/licenses/>.
0
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
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
23 The third party projects are under compatible licences (see below)
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
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
27 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
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
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
29
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
30
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
31 ** ABOUT **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
32
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
33 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
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
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
35
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
36
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
37 ** REQUIREMENTS **
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
38
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
39 To run the website, you need to install first Python 2.7 and some Python modules:
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
40 - virtualenv and virtualenvwrapper are always nice to have
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
41 - pip
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
42
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
43 Then install the project own dependencies:
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
44
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
45 pip install -r requirements/base.txt
31
31d196cf3b34 add settings ASSO_MEMBERS_*, ASSO_FINANCE_* and LIBERVIA_DEMO_URL
souliane <souliane@mailoo.org>
parents: 29
diff changeset
46
24
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
47
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
48 ** RUNNING THE WEBSITE LOCALLY **
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 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
51 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
52
60
0d20fb28c32e many small changes:
souliane <souliane@mailoo.org>
parents: 58
diff changeset
53 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
54
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
55 ./manage.py syncdb
60
0d20fb28c32e many small changes:
souliane <souliane@mailoo.org>
parents: 58
diff changeset
56
0d20fb28c32e many small changes:
souliane <souliane@mailoo.org>
parents: 58
diff changeset
57 If you modify some strings in the Django code, update the i18n .po files with:
0d20fb28c32e many small changes:
souliane <souliane@mailoo.org>
parents: 58
diff changeset
58
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
59 ./manage.py makemessages -a
60
0d20fb28c32e many small changes:
souliane <souliane@mailoo.org>
parents: 58
diff changeset
60
0d20fb28c32e many small changes:
souliane <souliane@mailoo.org>
parents: 58
diff changeset
61 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):
0d20fb28c32e many small changes:
souliane <souliane@mailoo.org>
parents: 58
diff changeset
62
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
63 ./manage.py compilemessages
24
c6a3ca0429dd add local_settings.py and instructions to run the website locally
souliane <souliane@mailoo.org>
parents: 23
diff changeset
64
60
0d20fb28c32e many small changes:
souliane <souliane@mailoo.org>
parents: 58
diff changeset
65 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
66
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
67 ./manage.py runserver
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
68
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
69 You can also specify the interface and port, for example:
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
70
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
71 ./manage.py runserver 192.168.2.1:8000
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
72
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
73
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
74 ** HOW TO DEPLOY **
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
75
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
76 After having adapted the settings for your productive environment, you can run:
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
77
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
78 ./deploy.sh
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
79
23
2fdbf8ebb72b upgrade to Django 1.7.3
souliane <souliane@mailoo.org>
parents: 1
diff changeset
80
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
81 ** CREDIT **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
82
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
83 The following third party project are shipped with this source code:
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
84
26
3df49721008c upgrade to Bootstrap v3.3.1
souliane <souliane@mailoo.org>
parents: 24
diff changeset
85 - 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
86 - 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
87
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
88 In addition, this project uses Django to run.
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
89
149
b1c16cd53b62 update django to version 1.11, refactor project structure, better PEP-8 compliance
souliane <souliane@mailoo.org>
parents: 94
diff changeset
90 Thanks to the authors/contributors of these projects.
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
91
64
1fb1e233d63f update README
souliane <souliane@mailoo.org>
parents: 60
diff changeset
92
0
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
93 ** CONTACT **
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
94
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
95 Jérôme Poisson
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
96
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
97 e-mail: goffi@goffi.org
9305c6458e2f initial commit
Goffi <goffi@goffi.org>
parents:
diff changeset
98 jid: goffi@jabberfr.org