Commit 3342a213 authored by maxime's avatar maxime

Update README.md

parent 0b24f647
......@@ -45,3 +45,102 @@ https://gnsafrance.org
## Launch server
source env/bin/activate # optional venv
python3 manage.py runserver
## FAQ
**1. Installation et la personnalisation de la plateforme**
* Quels sont les configurations serveur ?
Voici un exemple issue d'un site en production :
Type : Python WSGI
Default path : votre-dossier/production/united4earth/wsgi.py
Working directory : /united4earth/production/
Python version : 3.6.7
Static paths : /static/=/votre-dossier/production/united4earth/staticfiles/
* Comment mettre mon logo ?
Placez votre logo dans le fichier des images disponible ici :
/united4earth/static/img/
Ouvrez le fichier "header.html" disponible ici :
/united4earth/templates/data_manager/header.html
Allez à la ligne 10 du fichers et remplacer "logo_beta_gros.png" par le nom de votre logo
* Comment changer les couleurs du site ?
Les fichiers de style sont disponible dans le dossier suivant :
united4earth/static/scss/
Au sein de ce dossier vous trouverez différents fichiers correspondant au sections du site.
Vous pouvez apportez les modificatitions globales des couleurs au sein des fichiers _global.scss et _mixins.scss
* Comment mettre à jour les couleurs et autres styles ?
Afin de mettre à jours les fichiers de style (css) vous devez compilez les fichez "scss". Pour ce faire tapez la commande suivante :
sass united4earth/static/scss/index.scss united4earth/static/css/united4earth.css
Si vous avez apportez des modifications sur la carte, tapez :
sass united4earth/static/scss/risefor-map.scss united4earth/static/css/risefor-map.css
* Comment charger moins d'élus pour la version de développement ?
Afin de rendre la version de développement plus légère vous avez la capacité à charger qu'une partie des élu.e.s. Pour ce faire, ajoutez "--dev" à la fin de la commande suivante python3 manage.py import_elected lors de l'installation.
ATTENTION : Si vous avez déjà chargé toute la base d'élu.e.s vous devrez les supprimer via l'interphase admin.
Commande entière : python3 manage.py import_elected --dev
Cette commande chargera 10 élu.e.s à la fois.
* Est-ce que je peux ajouter des fonctionnalités ?
Biensur ! Le concept de Risefor est d'évoluer en fonction des besoins de ses utilisateurs.trices. Nous avons créé un groupe dédié permettant d'échanger sur le sujet, venez la proposer !
* Est-ce que je peux enlever des fonctionnalités ?
Sans soucis ! Retirez les sections qui ne vous sont pas utile, l'outil est fait pour ! :)
**2. Première utilisation**
* Comment accéder à l'interphase d'administration
Par default pour accéder à l'interphase d'administration vous n'avez qu'à ajoutez "/admin" après le nom de domaine.
Connectez vous avec le compte créé à l'étape 5 de l'installation.
Exemple : exemple.com/admin
* Je n'ai pas de thème, de fréquence ou de type d'organisations proposé dans mes formulaires
Vous devez créer les choix qui seront disponible au sein de la plateforme d'administration. Accédez y en ajoutant "/admin" à la fin de votre url.
Une fois connectez, ajoutez des choix au sein des sections "thème d'actions", "fréquence" et "Type d'organisations"
* Quand j'installe l'outil la carte des actions est grise
La carte reste grisé tant qu'il n'y a pas d'actions. Créez une action, avec une adresse, et la carte se mettra à jour
* Erreur "AllowHost"
Si vous avez installé Risefor sur un site et recevez cette erreur
Ouvrez le fichier settings.py dans le dossier united4earth
Cherchez le terme "ALLOWED_HOSTS"
Ajoutez votre nom de domaine au sein des crochet
Exemple : ALLOWED_HOSTS = ['mon-domaine.org']
**3. Autres questions**
* Comment déployer mon site local ?
Vous avez un fichier "deploy.sh" présent à la racine de l'application.
Au sein de se fichier remplacez la ligne u4e@ssh-u4e.happy-dev.fr par vos identifiant de ssh puis appelez ce fichier.
ATTENTION : Assurez vous d'être bien connectez à vore dépot git ! (vim .git/config)
Exemple : ./deploy.sh staging -> Déploie la commande sur le domaine correspondant à "staging"
* Comment apporter les mises à jours de l'application ?
Une fois que nous avons fini une fonctionnalité, ou une amélioration, nous la mettons en ligne sur la branche "master" du compte git.
Vous pouvez télécharger les modifications en réalisant la commande ci-dessous depuis la racine du dossier de l'application
git pull origin master
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment