From b2af6af2b4662a30dada1773040f57b49e6dc9eb Mon Sep 17 00:00:00 2001 From: Rushil Umaretiya Date: Sun, 28 Mar 2021 11:58:40 -0400 Subject: [PATCH] github: added demo instructions to README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 4a672cc..2b469d8 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,36 @@ ## Demo: https://www.youtube.com/watch?v=z9iJFXSoQCM +## How to run + +1. After cloning repo make sure you have the latest `nodejs` LTS and `python3.8` installed +2. Install pipenv +``` +cd backend +python -m pip install pipenv +``` +3. Install deps +``` +pipenv install +``` +4. Set up django +``` +cd config +cp .env.sample .env +cd .. +pipenv run python manage.py migrate +pipenv run python manage.py runserver +``` +5. Open another terminal window to run the frontend and run the following commands +``` +npm install -g yarn +cd frontend +yarn +yarn start +``` +Note: You must have both the backend and frontend running, specifically on ports 8000 and 3000 respectively. + + ## Inspiration We were inspired to do this project in light of the women’s advocacy and their troubles. One of our members was scrolling through instagram and saw this and thought that it would be useful to have a similar platform catered to individuals to post about their political views where policy makers can actually see support for certain topics.