Salut à Toi's website
(c) Jérôme Poisson aka Goffi 2012
(c) Adrien Cossa aka Souliane 2015


** LICENCE **

SàT website is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

SàT website is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with SàT website. If not, see <http://www.gnu.org/licenses/>.

---

The third party projects are under compatible licences (see below)

---

The media in /static/images and /static/videos comes from Salut à Toi project and are under Creative Commons licence CC By-SA
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


** ABOUT **

This is the source code of Salut à Toi's presentation website.
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).


** REQUIREMENTS **

To run the website, you need to install first Python 2.7 and some Python modules:
  - virtualenv and virtualenvwrapper are always nice to have
  - pip

Then install the project own dependencies:

  pip install -r requirements/base.txt


** RUNNING THE WEBSITE LOCALLY **

This is the basic procedure to run the website on your local machine using the Django built-in web server.
Please make the difference between the project directory (e.g. ~/workspace/sat_website) and the app directory (e.g. ~/workspace/sat_website/sat_website).

In the project directory, enter this command to initialise the website (this has to be done only once):

  ./manage.py syncdb

If you modify some strings in the Django code, update the i18n .po files with:

  ./manage.py makemessages -a

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):

  ./manage.py compilemessages

Whenever you want to launch the web server:

  ./manage.py runserver

You can also specify the interface and port, for example:

  ./manage.py runserver 192.168.2.1:8000


** HOW TO DEPLOY **

After having adapted the settings for your productive environment, you can run:

  ./deploy.sh


** CREDIT **

The following third party project are shipped with this source code:

    - Bootstrap v3.3.1 (http://getbootstrap.com) | Copyright 2011-2014 Twitter, Inc. | MIT licence: https://github.com/twbs/bootstrap/blob/master/LICENSE
    - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license

In addition, this project uses Django to run.

Thanks to the authors/contributors of these projects.


** CONTACT **

Jérôme Poisson

e-mail: goffi@goffi.org
jid: goffi@jabberfr.org