Plateforme numérique de l'Association d'Action Éducative 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 ed8b33e447 [fix] Corrige la classe d'un champ requis 1 month ago
assets [fix] Corrige la classe d'un champ requis 1 month ago
boiteaasso [fix] Remplace fsforms dans la liste des annonces 1 month ago
requirements [ref] Remplace django-fsforms par django-tapeforms 2 months ago
styleguide [dev] Positionne le menu du guide en sticky 5 months ago
.babelrc [dev] Mets à jour les paquets et l'environnement Gulp 5 months ago
.browserslistrc [dev] Mets à jour les paquets et l'environnement Gulp 5 months ago
.eslintrc [dev] Ajoute .eslintrc pour ESLint 7 months ago
.gitignore [dev] Réactive la génération de la maquette via npm 5 months ago
.jshintrc [dev] Ajoute JSHint pour vérifier le code JavaScript 9 months ago
.sass-lint.yml [dev] Mets à jour les paquets npm et les règles sass-lint 9 months ago
CHANGELOG.md [ref] Renomme la plateforme en Boite à Asso 11 months ago
LICENSE [init] Inclus le squelette de l'application avec Wagtail 1 year ago
Makefile [test] Passe à pytest pour l'éxecution 2 months ago
README.md [ref] Renomme la plateforme en Boite à Asso 11 months ago
config.env.example [enh] Ajoute DEFAULT_FROM_EMAIL dans la configuration 11 months ago
gulpfile.js [build] Utilise le preset babel à la transpilation 2 months ago
manage.py [fix] Récupère le module settings depuis config.env dans manage.py 11 months ago
package-lock.json [build] Mets à jour les dépendances NPM 2 months ago
package.json [build] Mets à jour les dépendances NPM 2 months ago
pytest.ini [test] Passe à pytest pour l'éxecution 2 months ago
requirements.txt [init] Inclus le squelette de l'application avec Wagtail 1 year ago
setup.cfg [dev] Configure flake8 pour l'application 11 months ago

README.md

Boite à Asso

La plateforme numérique de l’Association d’Action Éducative du Pas-de-Calais.

Installation

Requirements

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

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

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 Plateforme de l’AAE62, 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 boiteaasso/. 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.

Licence

Cette application est développée par Cliss XXI sous licence AGPLv3+.