Skip to content

Latest commit

 

History

History
143 lines (100 loc) · 3.21 KB

README.md

File metadata and controls

143 lines (100 loc) · 3.21 KB
Raw

Find My Protest Logo

Find My Protest

Demo • Setup • Team

Find My Protest is a platform which displays historical and future protest data, allowing users to find events in Berlin based on their search criteria. Additionally, through predictive analytics the platform shows crowd predictions of future protests, empowering users to make informed decisions and actively participate in events aligned with their values.

Demo

https://drive.google.com/drive/folders/19AauH9hKPJSslkwdzg606HcCzV1-06Jy

Setup

1. Requirements:

2. Running the project:

Clone the project's repository to your local machine by writing the following command in your terminal:

# CLONE REPOSITORY
git clone https://github.com/TechLabs-Berlin/ws24-mass-protest-across-countries.git

Access the project directory then the application in the ./App/folder :

# OPEN PROJECT DIRECTORY
cd ws24-mass-protest-across-countries
# OPEN APP FOLDER
cd App

3. Starting the React client:

Open the ./client/ folder, install dependencies and start the React app by writing the following commands in your terminal:

# OPEN CLIENT FOLDER
cd client
# INSTALL DEPENDENCIES
npm i
# AND IF NEEDED
npm i react
# START RUNNING APP
npm start

4. Starting the Express server and loading the app data on MongoDB:

In a new terminal window, open the ./server/ folder, install dependencies and start the Express server with the following terminal commands:

# OPEN SERVER FOLDER
cd server
# INSTALL DEPENDENCIES
npm i
# AND IF NEEDED
npm i express mongoose
# LOAD DATA IN MongoDB
node seed.js
# START EXPRESS SERVER
node index.js

You are sucessfully connected if you can see the following lines in you terminal:

Serving on port 8000
Database connected
Database connected

5. Navigating the Web App:

The React client runs on port 3000 in your local browser. To access the landing page, type the following address in your browser:

As shown in ./client/src/App.js, the URLs path that can be accessed are /, /contact, /about, /login as well as /test-api to make sure the backend server is successfully connected.

6. Navigating the API server:

The Express server runs on local port 8000. To access the api langing page, type this address in your browser:

As indicated in ./server/routes/router.js, accessible paths are /, /api/test, /api/protest and /api/search.

Team

Contributors:

  • DL: Tuğba Eraslanoğlu
  • DS: Paula Hierzi, Irem Bayram
  • UX: Mana Nosrati, Weronika Ajimati
  • WD: Lydie Kouang (FE & BE), Annika Reynders (FE)

Mentors:

  • UX: Tatiana Olar
  • WD: Aljoscha Beiers
  • DS/DL: Rafael Saraiva