From 6b365873aa700faa6c02e49e89b23a284f3fbc47 Mon Sep 17 00:00:00 2001 From: Maxime <maximesenzamici@gmail.com> Date: Wed, 18 May 2022 11:16:05 +0200 Subject: [PATCH] Update README.md --- README.md | 54 +++++++++--------------------------------------------- 1 file changed, 9 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index d59f56ba5..0a528b569 100644 --- a/README.md +++ b/README.md @@ -9,71 +9,35 @@ This is the code repository of Risefor, you can get information or contact the t This package contains the full version of Risefor. On each instance, users will be able to create actions on specific subjects & connect them to representatives in order to invite citizen to contact them. -* See the demo here: https://demo.risefor.org/ +* See the official deployment here: https://agir.risefor.org/ * Code available on the branch : [risefor_main/master](https://git.startinblox.com/applications/risefor-front) -We are currently working on a full revamp in order to improve the Look & Feel as well as the performances -* See the ongoing work here : https://dev.risefor.org/ -* Code available on the branch : [risefor_main/united4earth/dev](https://git.startinblox.com/applications/risefor-front/tree/risefor_main/united4earth/dev) **2. Risefor Light:** -Risefor light allows you to deploy a landing page on a specific law easily +Risefor light allows you to deploy a landing page on a specific subject easily * Examples of Risefor light: -\- International campaign : https://cop26.rebellion.global/ +\- Local issue : https://agir.ouialafermeecoledebagnolet.fr/ -\- Campaign accompanying a physical action : http://bop.extinctionrebellion.fr/ +\- Campaign accompanying a physical action : https://deni-democratie.extinctionrebellion.fr/ -\- Campaign targeting a specific law : https://stop-covid.risefor.org/ * Code available on the branch : [risefor_light/master](https://git.startinblox.com/applications/risefor-front/tree/risefor_light/main) ## Installing the tool : -``` -git clone https://git.startinblox.com/applications/risefor-front -cd <repository> -git checkout risefor_main/master OR git checkout risefor_light/master -python3 -m venv env # optional venv -. env/bin/activate # optional venv -pip3 install -r requirements.txt -cd united4earth -sib install united4earth -python3 manage.py runserver -``` +Local and server installation tools are available here: https://gitlab.com/maxime_senza/risefor-server-configs -By default the app will run localy on http://127.0.0.1:8000/ +By default the app will run localy on http://localhost:8000/ +_More documentation is available in the installation tool repository._ ## Common customizations : -* Changing the logo : - -1. Upload your logo in the file /united4earth/static/img/Logos -2. Edit the header.html [file here](https://git.startinblox.com/applications/risefor-front/blob/risefor_main/master/united4earth/templates/united4earth/header.html#L8) - -* Changing the colors : -1. Open the file "variables.scss" -2. Edit the "main", "secondary", "third", "alert" and "extra" colors [here](https://git.startinblox.com/applications/risefor-front/blob/risefor_main/master/united4earth/static/scss/src/_variables.scss#L12) -3. Compile scss using `sass static/scss/index.scss static/css/united4earth.css` - - -* Changing the fonts : -1. Open the file "variables.scss" -2. Change the fonts [here ](https://git.startinblox.com/applications/risefor-front/blob/risefor_main/master/united4earth/static/scss/src/_variables.scss#L27) -3. If these are custom or new fonts, declare [them here](https://git.startinblox.com/applications/risefor-front/blob/risefor_main/master/united4earth/static/scss/src/_global.scss#L6) - -* How to update the css : -We use a css framework called "sass". If you want to make changes to the css, the should : - -1. Edit scss files available in /static/scss -2. Compile scss with the following command `sass static/scss/index.scss static/css/united4earth.css` to see the changes (you can add `--watch` if you are doing multiple changes) - -For more information on sass visit [their website](https://sass-lang.com/) +Find the faq and all the steps to customize here : https://agir.risefor.org/installer-risefor ## For more help -1. We are working on a FAQ available here: https://risefor.org/installer-risefor -2. You can always contact the team by [opening an issue](https://git.startinblox.com/applications/risefor-front/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=) or by [sending us an email](https://risefor.org/contact) +Contact us over here https://agir.risefor.org/contact -- GitLab