Mercurial > sat_legacy_website

comparison README @ 64:1fb1e233d63f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update README
author souliane <souliane@mailoo.org>
date Sat, 16 May 2015 10:13:52 +0200
parents 0d20fb28c32e
children c1b77f07f644
comparison
equal deleted inserted replaced
63:1e6dae0231e9 64:1fb1e233d63f
1 Salut à Toi's website 1 Salut à Toi's website
2 (c) Jérôme Poisson aka Goffi 2012 2 (c) Jérôme Poisson aka Goffi 2012
3 (c) Adrien Cossa aka Souliane 2015 3 (c) Adrien Cossa aka Souliane 2015
4
4 5
5 ** LICENCE ** 6 ** LICENCE **
6 7
7 SàT website is free software: you can redistribute it and/or modify 8 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 it under the terms of the GNU Affero General Public License as
24 --- 25 ---
25 26
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/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 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
30
29 ** ABOUT ** 31 ** ABOUT **
30 32
31 This is the source code of Salut à Toi's presentation website. 33 This is the source code of Salut à Toi's presentation website.
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). 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).
33 35
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 )
43
34 ** SETTINGS ** 44 ** SETTINGS **
35 45
36 The following values can be set in site's settings.py: 46 Please check the local_settings.py file which is distributed in the sat_website directory.
47 This is a template describing and initialising all settings.
37 48
38 # External URL pointing the external media files
39 MEDIA_EXTERNAL_URL = 'ftp://ftp.goffi.org/media'
40
41 # External URL pointing the projects archives directory
42 PROJECTS_EXTERNAL_URL = 'ftp://ftp.goffi.org'
43
44 # Internal path to the projects archives directory
45 PROJECTS_INTERNAL_PATH = '/var/www/projects'
46
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)]
49
50 # Extension used to name the project archives
51 ARCHIVE_SUFFIX = '.tar.bz2'
52
53 # URL to Libervia online demo
54 LIBERVIA_DEMO_URL = 'https://www.libervia.org'
55
56 # Actual and target number of members
57 ASSO_MEMBERS_ACTUAL = 3400
58 ASSO_MEMBERS_TARGET = 6000
59
60 # Actual and target amount to finance the association (in euros)
61 ASSO_FINANCE_ACTUAL = 40000
62 ASSO_FINANCE_TARGET = 60000
63
64 # Subscription amounts as defined in the Rules of Procedure
65 ASSO_SUBSCR_AMOUNTS = (0, 10, 20, 30, 50, 80, 100)
66
67 # Path the CSV file where all the subscriptions are written
68 ASSO_SUBSCR_CSV = "/home/souliane/sat_website_subscriptions.csv"
69
70 # Bank account information
71 ASSO_IBAN = u"FR76 1027 8060 4300 0207 3220 109"
72 ASSO_BIC = u"CMCIFR2A"
73
74 # URL to the Statutes and Rules of the association
75 ASSO_URL_STATUTES = 'http://repos.goffi.org/sat_docs/raw-file/tip/association/statuts.pdf'
76 ASSO_URL_RULES = 'http://repos.goffi.org/sat_docs/raw-file/tip/association/r%C3%A8glement%20int%C3%A9rieur.pdf'
77
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 *
82
83 Note that the Django application "markdown_deux" ( https://github.com/trentm/django-markdown-deux ) is required.
84 For more information, check the local_settings.py file which is distributed in the sat_website directory.
85 49
86 ** RUNNING THE WEBSITE LOCALLY ** 50 ** RUNNING THE WEBSITE LOCALLY **
87 51
88 This is the basic procedure to run the website on your local machine using the Django built-in web server. 52 This is the basic procedure to run the website on your local machine using the Django built-in web server.
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). 53 Please make the difference between the project directory (e.g. ~/workspace/sat_website) and the app directory (e.g. ~/workspace/sat_website/sat_website).
90 54
91 First add these two lines to your shell .*rc file: 55 First add these two lines to your shell .*rc file:
92 56
93 export PYTHONPATH=$PYTHONPATH:<path_to_the_app_directory> 57 export PYTHONPATH=$PYTHONPATH:<path_to_the_app_directory>
94 export DJANGO_SETTINGS_MODULE=settings 58 export DJANGO_SETTINGS_MODULE=settings
95 59
96 Create in the app directory a file settings.py containing these lines: 60 Create in the app directory a file settings.py containing these lines:
97 61
98 try: 62 try:
99 from local_settings import * 63 from local_settings import *
100 except ImportError: 64 except ImportError:
101 pass 65 pass
102 66
67 You can overwrite settings in settings.py after these lines.
103 In the project directory, enter this command to initialise the website (this has to be done only once): 68 In the project directory, enter this command to initialise the website (this has to be done only once):
104 69
105 django-admin syncdb 70 django-admin syncdb
106 71
107 If you modify some strings in the Django code, update the i18n .po files with: 72 If you modify some strings in the Django code, update the i18n .po files with:
108 73
109 django-admin makemessages -a 74 django-admin makemessages -a
110 75
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): 76 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 77
113 django-admin compilemessages 78 django-admin compilemessages
114 79
115 Whenever you want to launch the web server: 80 Whenever you want to launch the web server:
116 81
117 django-admin runserver 82 django-admin runserver
83
84 You can also specify the interface and port, for example:
85
86 django-admin runserver 192.168.2.1:8000
87
118 88
119 ** CREDIT ** 89 ** CREDIT **
120 90
121 The following third party project are shipped with this source code: 91 The following third party project are shipped with this source code:
122 92
123 - Bootstrap v3.3.1 (http://getbootstrap.com) | Copyright 2011-2014 Twitter, Inc. | MIT licence: https://github.com/twbs/bootstrap/blob/master/LICENSE 93 - 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 94 - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license
125 95
126 In addition, this project use Django to run. 96 In addition, this project uses Django to run.
127 97
128 Thanks to the authors/contributors of these projects 98 Thanks to the authors/contributors of these projects
99
129 100
130 ** CONTACT ** 101 ** CONTACT **
131 102
132 Jérôme Poisson 103 Jérôme Poisson
133 104