Plate-forme pour les organisations de l'Économie Sociale et Solidaire du Pas-de-Calais
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jérôme Lebleu 93a6d6ce3e fix(assets): supprime leaflet du dossier static 5 months ago
assets ref(assets): revois et mets à jour l'environnement 5 months ago
ess62_plateforme fix(assets): supprime leaflet du dossier static 5 months ago
requirements [enh] Mets en forme les éléments avec Bootstrap 1 year ago
styleguide ref(assets): revois et mets à jour l'environnement 5 months ago
.babelrc ref(assets): revois et mets à jour l'environnement 5 months ago
.browserslistrc ref(assets): revois et mets à jour l'environnement 5 months ago
.editorconfig ref(assets): revois et mets à jour l'environnement 5 months ago
.eslintrc ref(assets): revois et mets à jour l'environnement 5 months ago
.gitignore ref(assets): revois et mets à jour l'environnement 5 months ago
.stylelintrc ref(assets): revois et mets à jour l'environnement 5 months ago
CHANGELOG.md [init] Initialise le projet avec cookiecutter-django_c21 1 year ago
LICENSE [init] Initialise le projet avec cookiecutter-django_c21 1 year ago
Makefile [init] Initialise le projet avec cookiecutter-django_c21 1 year ago
README.md [init] Initialise le projet avec cookiecutter-django_c21 1 year ago
config.env.example [init] Initialise le projet avec cookiecutter-django_c21 1 year ago
gulpfile.js ref(assets): revois et mets à jour l'environnement 5 months ago
manage.py [fix] Charge la configuration depuis config.env dans manage.py 1 year ago
package-lock.json ref(assets): revois et mets à jour l'environnement 5 months ago
package.json ref(assets): revois et mets à jour l'environnement 5 months ago
requirements.txt [init] Initialise le projet avec cookiecutter-django_c21 1 year ago
setup.cfg [init] Initialise le projet avec cookiecutter-django_c21 1 year ago

README.md

Plate-forme du CDESS

La plate-forme pour les organisations de l’Économie Sociale et Solidaire du Pas-de-Calais.

Installation

Requirements

On a Debian-based host - running at least Debian Stretch, you will need the following packages:

  • python3
  • virtualenv
  • python3-psycopg2 (optional, in case of a PostgreSQL database)

Note: if you’re serving the application with uWSGI and NGINX on a sub location, ensure that you’ve added route-run = fixpathinfo: to your uWSGI configuration (from v2.0.11).

Step by step

In waiting for a complete Makefile, you will have to follow those steps to install the application.

It assumes that you have downloaded the last release of Plate-forme du CDESS, extracted it and that you moved to that folder.

  1. Start by creating a new virtual environment under ./venv and activate it:

    $ virtualenv --system-site-packages ./venv
    $ source ./venv/bin/activate
    
  2. Install the required Python packages depending on your environment:

    $ pip install -r requirements/production.txt
    ... or ...
    $ pip install -r requirements/development.txt
    
  3. Configure the application by setting the proper environment variables depending on your environment. You can use the config.env.example which give you the main variables with example values.

    $ cp config.env.example config.env
    $ nano config.env
    

    Note that this ./config.env file will be loaded by default when the application starts. If you don’t want that, just move this file away or set the DJANGO_READ_CONFIG_FILE environment variable to false.

  4. Create the database tables - it assumes that you have created the database and set the proper configuration to use it:

    $ ./manage.py migrate
    

That’s it! You should now be able to start the Django development server to check that everything is working fine with:

$ ./manage.py runserver

Structure

Overview

All the application files - e.g. Django code including settings, templates and statics - are located into the ess62_plateforme/. It should permit in a near future to distribute the application as a Python package and install it system-wide.

Two environments are defined - either for requirements and settings:

  • development: for local application development and testing. It uses a SQLite3 database and enable debugging by default, add some useful settings and applications for development purpose - i.e. the django-debug-toolbar.
  • production: for production. It checks that configuration is set and correct, try to optimize performances and enforce some settings - i.e. HTTPS related ones.

Local changes

You can override and extend statics and templates locally. This can be useful if you have to change the logo for a specific instance for example. For that, just put your files under the local/static/ and local/templates/ folders.

Regarding the statics, do not forget to collect them after that. Note also that the local/ folder is ignored by git.

Variable content

All the variable content - e.g. user-uploaded media, collected statics - are stored inside the var/ folder. It is also ignored by git as it’s specific to each application installation.

So, you will have to configure your Web server to serve the var/media/ and var/static/ folders, which should point to /media/ and /static/, respectively.

License

Plate-forme du CDESS is developed by Cliss XXI and licensed under the AGPLv3+.