view 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
line wrap: on
line source

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

** SETTINGS **

The following values can be set in site's settings.py:

    # External URL pointing the external media files
    MEDIA_EXTERNAL_URL = 'ftp://ftp.goffi.org/media'

    # External URL pointing the projects archives directory
    PROJECTS_EXTERNAL_URL = 'ftp://ftp.goffi.org'

    # Internal path to the projects archives directory
    PROJECTS_INTERNAL_PATH = '/var/www/projects'

    # List of couples with the project directory name and the project name (set to None if it's the same)
    PROJECTS_NAMES = [('sat', None), ('sat_media', None), ('urwid-satext', 'urwid_satext'), ('sat_pubsub', None), ('libervia', None)]

    # Extension used to name the project archives
    ARCHIVE_SUFFIX = '.tar.bz2'

    # URL to Libervia online demo
    LIBERVIA_DEMO_URL = 'https://www.libervia.org'

    # Actual and target number of members
    ASSO_MEMBERS_ACTUAL = 3400
    ASSO_MEMBERS_TARGET = 6000

    # Actual and target amount to finance the association (in euros)
    ASSO_FINANCE_ACTUAL = 40000
    ASSO_FINANCE_TARGET = 60000

    # Subscription amounts as defined in the Rules of Procedure
    ASSO_SUBSCR_AMOUNTS = (0, 10, 20, 30, 50, 80, 100)

    # Path the CSV file where all the subscriptions are written
    ASSO_SUBSCR_CSV = "/home/souliane/sat_website_subscriptions.csv"

    # Bank account information
    ASSO_IBAN = u"FR76 1027 8060 4300 0207 3220 109"
    ASSO_BIC = u"CMCIFR2A"

    # URL to the Statutes and Rules of the association
    ASSO_URL_STATUTES = 'http://repos.goffi.org/sat_docs/raw-file/tip/association/statuts.pdf'
    ASSO_URL_RULES = 'http://repos.goffi.org/sat_docs/raw-file/tip/association/r%C3%A8glement%20int%C3%A9rieur.pdf'

    # 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)
    from sys import path
    path.append('/home/souliane')
    from sat_website_external_settings import *

Note that the Django application "markdown_deux" ( https://github.com/trentm/django-markdown-deux ) is required.
For more information, check the local_settings.py file which is distributed in the sat_website directory.

** 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).

First add these two lines to your shell .*rc file:

export PYTHONPATH=$PYTHONPATH:<path_to_the_app_directory>
export DJANGO_SETTINGS_MODULE=settings

Create in the app directory a file settings.py containing these lines:

try:
    from local_settings import *
except ImportError:
    pass

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

django-admin syncdb

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

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

django-admin compilemessages

Whenever you want to launch the web server:

django-admin runserver

** 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 use 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