README.md 5.72 KB
Newer Older
maxime's avatar
maxime committed
1
**[Risefor.org](https://risefor.org/)**
maxime's avatar
maxime committed
2

maxime's avatar
maxime committed
3 4
Risefor.org is an open-source tool designed to allow citizens to exchange, organise and act upon their elected officials.
Using Risefor.org, citizens can gather around a common topic of interest and advocate for an agreed upon position to their elected officials.
maxime's avatar
maxime committed
5

maxime's avatar
maxime committed
6
Find out more on : https://risefor.org/
maxime's avatar
maxime committed
7

maxime's avatar
maxime committed
8
## Check out Risefor installed on :
maxime's avatar
maxime committed
9 10 11 12
https://agir.united4earth.org

http://action.humanconet.org

maxime's avatar
maxime committed
13 14
http://habitat-leger.org

maxime's avatar
maxime committed
15 16 17
https://referendum.signons.fr

https://gnsafrance.org
maxime's avatar
maxime committed
18

maxime's avatar
maxime committed
19

Alexandre's avatar
Alexandre committed
20
## Installation
21

maxime's avatar
maxime committed
22 23
    git clone https://git.happy-dev.fr/startinblox/applications/risefor-lobbying.git
    cd risefor-lobbying
24 25 26
    python3 -m venv env # optional venv
    . env/bin/activate  # optional venv
    pip3 install -r requirements.txt
Alexandre's avatar
Alexandre committed
27 28
    cp united4earth/settings_sample.py united4earth/settings.py
    touch united4earth/templates/data_manager/google-analytics.html
29
    python3 manage.py migrate
30
    python3 manage.py import_elected
31 32
    python3 manage.py import_senators
    python3 manage.py enhance_elected
33
    python3 manage.py createsuperuser
34

maxime's avatar
maxime committed
35 36 37 38 39

## To only install couple elected officials for dev installation
    python3 manage.py import_elected --dev
    python3 manage.py enhance_elected

Alexandre's avatar
Alexandre committed
40 41
## Update CSS
    npm install -g sass
Alexandre's avatar
Alexandre committed
42
    sass --watch united4earth/static/scss/index.scss united4earth/static/css/united4earth.css
Alexandre's avatar
Alexandre committed
43
    sass --watch united4earth/static/scss/risefor-map.scss united4earth/static/css/risefor-map.css
Alexandre's avatar
Alexandre committed
44 45 46 47

## Launch server
    source env/bin/activate # optional venv
    python3 manage.py runserver
maxime's avatar
maxime committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146


## 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