LGD-Fr / paiji2

student social portal at Supélec, Metz

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

paiji2

Build Status Code Climate Coverage Status Requirements Status

Install guidelines

Getting last version

First, you have to get the last release of this repository (or a previous one). For so, clone it into the directory of your choice :

git clone https://github.com/rezometz/paiji2.git

Then go into the newly created directory named "paiji2" which will be referenced as "working directory" in the next paragraphs.

See http://wiki.rezometz.org for more details.

Virtualenv

As we are using new releases of python packages and to avoid inconsistency in your system configuration with python packages, we advice you to configure a virtual environment.

First, you have to install virtualenv and virtualenvwrapper (recommended).

Then create the virtualenv by typing (in your working directory) :

mkvirtualenv paiji2 -r 'requirement/devs.txt'
pip install -r 'requirements/custom_packages.txt'

Configure the website

You can now configure your website. Start by copying the settings_example.py file as settings.py (in the paiji2 directory) :

cd paiji2
cp settings_example.py settings.py

Then open the settings.py file and change the different environments variables as you wish.

Static Files

First you will need to install nodejs and bower in the virtualenv.

npm install -g bower

Then in django to fetch the JS and CSS files run:

python manage.py bower install

Debug mode

You are now fully prepared to work on on the project on development mode. The project can be launched using :

python manage.py runserver

Nevertheless, never forget two things :

  • you have to use your defined virtual env when launching the server (or in any cases using the manage.py file)
  • never use this in production mode.

Further explanations will be given to deploy it in production mode later

Modules

Name Travis CodeClimate Coveralls
paiji2 Build Status Code Climate Coverage Status
utils Build Status Code Climate Coverage Status
social Build Status Code Climate Coverage Status
shoutbox Build Status Code Climate Coverage Status
carpooling Build Status Code Climate Coverage Status
infoconcert Build Status Code Climate Coverage Status
survey Build Status Code Climate Coverage Status
weather Build Status Code Climate Coverage Status
mettis Build Status Code Climate Coverage Status
forum Build Status Code Climate Coverage Status
comic Build Status Code Climate Coverage Status

About

student social portal at Supélec, Metz

License:GNU Affero General Public License v3.0


Languages

Language:Python 57.1%Language:HTML 36.0%Language:Shell 3.7%Language:CSS 3.2%