12310c7bdb | ||
---|---|---|
artwork | ||
assets | ||
benevalibre | ||
docs | ||
requirements | ||
styleguide | ||
.babelrc | ||
.browserslistrc | ||
.editorconfig | ||
.eslintrc | ||
.gitattributes | ||
.gitignore | ||
.stylelintrc | ||
CHANGELOG.md | ||
CONTRIBUTORS.txt | ||
LICENSE | ||
Makefile | ||
README.fr.md | ||
README.md | ||
config.env.example | ||
gulpfile.js | ||
manage.py | ||
package-lock.json | ||
package.json | ||
pyproject.toml | ||
requirements.txt | ||
setup.cfg |
README.fr.md
Bénévalibre est un logiciel libre qui facilite la gestion et la valorisation du bénévolat dans les associations.
Table des matières
Essayer rapidement
Sur une machine Debian, version Stretch ou ultérieure :
$ sudo apt install python3 virtualenv git make
$ git clone https://forge.cliss21.org/cliss21/benevalibre
$ cd benevalibre/
$ make init
Une configuration va être éditée intéractivement. Décommentez
ENV=development
$ make test # optionnel
$ make serve
Visitez ensuite http://127.0.0.1:8000/ dans votre navigateur web.
Installation
Pré-requis
Sur une machine Debian, version Buster ou ultérieure, vous aurez besoin de :
- python3
- virtualenv
- make
- git (recommandée pour récupérer le source)
- python3-mysqldb (optionnel, pour une base de données MySQL / MariaDB)
- python3-psycopg2 (optionnel, pour une base de données PostgreSQL)
Démarrage rapide
On suppose que vous avez déjà téléchargé le code de l'application (la façon la plus simple pour cela est de cloner le dépôt) et que vous êtes dans le dossier.
-
Définissez votre configuration locale dans le fichier
config.env
, qui peut être copié depuisconfig.env.example
et édité selon vos besoins.En fonction de vos choix d'environnement, vous devrez créer la base de données associée son utilisateur.
-
Exécutez
make init
.Notez que si il n'y a pas de fichier
config.env
, il sera créé interactivement.
C'est tout ! Votre environnement est désormais initialisé et l'application
installée. Pour la mettre à jour, une fois le code récupéré, lancez simplement
make update
.
Vous pouvez aussi vérifier que l'application est bien configurée, en exécutant
make check
.
Déploiement
Voici un exemple de configuration de déploiement pour NGINX en tant que serveur Web avec uWSGI en serveur d'application.
Le serveur uWSGI ne requiert aucune configuration spéciale, excepté qu'on
utilise python3 et un virtualenv. Notez que si vous servez l'application
dans un chemin sous la racine, vous aurez à ajouter route-run = fixpathinfo:
à la configuration uWSGI (depuis
v2.0.11).
Dans le bloc server
de la configuration NGINX, ajoutez le bloc suivant et
définissez les chemins de l'installation et du socket uWGSI :
location / {
include uwsgi_params;
uwsgi_pass unix:<uwsgi_socket_path>;
}
location /media {
alias <app_instance_path>/var/media;
}
location /static {
alias <app_instance_path>/var/static;
# Optionnel : ne pas journaliser l'accès aux assets
access_log off;
}
location = /favicon.ico {
alias <app_instance_path>/var/static/favicon/favicon.ico;
# Optionnel : ne pas journaliser l'accès au favicon
access_log off;
}
Pour aller plus loin
Consultez la version anglaise de cette aide pour plus de détails techniques.
Licence
Bénévalibre est développé par Cliss XXI et distribué sous licence AGPLv3+.