Mercurial > sat_legacy_website
diff README @ 149:b1c16cd53b62
update django to version 1.11, refactor project structure, better PEP-8 compliance
author | souliane <souliane@mailoo.org> |
---|---|
date | Tue, 17 Oct 2017 04:11:21 +0200 |
parents | c1b77f07f644 |
children |
line wrap: on
line diff
--- a/README Tue Oct 17 19:18:44 2017 +0200 +++ b/README Tue Oct 17 04:11:21 2017 +0200 @@ -12,11 +12,11 @@ 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 +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/>. +along with SàT website. If not, see <http://www.gnu.org/licenses/>. --- @@ -36,16 +36,13 @@ ** REQUIREMENTS ** -To run the website you need: +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 - - Django 1.7.3 or superior ( https://www.djangoproject.com ) - - Django application "markdown_deux" ( https://github.com/trentm/django-markdown-deux ) - - Python module unicodecsv ( https://github.com/jdunck/python-unicodecsv ) +Then install the project own dependencies: -** SETTINGS ** - -Please check the local_settings.py file which is distributed in the sat_website directory. -This is a template describing and initialising all settings. + pip install -r requirements/base.txt ** RUNNING THE WEBSITE LOCALLY ** @@ -53,38 +50,32 @@ 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 - -You can overwrite settings in settings.py after these lines. In the project directory, enter this command to initialise the website (this has to be done only once): - django-admin syncdb + ./manage.py syncdb If you modify some strings in the Django code, update the i18n .po files with: - django-admin makemessages -a + ./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): - django-admin compilemessages + ./manage.py compilemessages Whenever you want to launch the web server: - django-admin runserver + ./manage.py runserver You can also specify the interface and port, for example: - django-admin runserver 192.168.2.1:8000 + ./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 ** @@ -96,7 +87,7 @@ In addition, this project uses Django to run. -Thanks to the authors/contributors of these projects +Thanks to the authors/contributors of these projects. ** CONTACT ** @@ -105,4 +96,3 @@ e-mail: goffi@goffi.org jid: goffi@jabberfr.org -