Merge pull request #41 from BU-Spark/Readme.md

Readme.md

README.md

@@ -1,12 +1,43 @@
 # TEMPLATE-base-repo
 
-# Add Users
-To add yourself to the repository, open a Pull Request modifying `COLLABORATORS`, entering your GitHub username in a newline.
+# Boston Voter App
 
-All Pull Requests must follow the Pull Request Template, with a title formatted like such `[Project Name]: <Descriptive Title>`
+# Description
+The Boston Voter App addresses the lack of accessible information about voting logistics and candidates in municipal elections in Boston. This progressive web application centralizes all vital voting information to increase voter turnout, particularly focusing on BIPOC voters who face significant barriers to voting in local elections. 
+
+# Problem Statement
+Many news organizations provide articles or voting guides around the election, but they are often difficult to find, last minute, and represent a narrow perspective around candidates. Additionally, most election resources are around larger races with little coverage or few resources available for local elections, where candidates have the potential to impact people’s lives more directly. BIPOC voters often have the lowest voting rates, especially in municipal elections, for a variety of reasons including lack of information and logistical barriers such as work hours and family duties. This project aims to remedy that for BIPOC voters in Boston.
+
+# Solution
+The Boston Voter App provides a comprehensive solution by offering:
+* Centralized voting information for Boston municipal elections.
+* Detailed candidate profiles, information about them and ballot initiatives.
+* Voting logistics including polling locations and hours.
+* Features to find the nearest polling booth locations.
+* Information about upcoming elections.
+* Tools and resources to help voters navigate logistical barriers, ultimately aiming to increase BIPOC voter turnout.
+
+# Installation
+* git clone https://github.com/BU-Spark/pitne-voter-app.git
+* cd pitne-voter-app 
+* npm install
+* cd client
+* npm run dev
+
+# Deployement 
+Access our deployed website through netlify at https://pitne-voter.netlify.app.
 
-Status of Deployment:
+Status of Deployment: 
 [![Netlify Status](https://api.netlify.com/api/v1/badges/2475ff74-781c-4ac2-b8c6-3966fa276ea6/deploy-status)](https://app.netlify.com/sites/pitne-voter/deploys)
 
+# Collaborators 
+* Arshnoor Kaur Chadha; Github: @arshnoorKC13
+* Elenaor Elkus; Github: @eelkus01
+* Jason Jiang; Github: @jasonjiang9142
+
+# Add Users {Additional Instructions}
+To add yourself to the repository, open a Pull Request modifying `COLLABORATORS`, entering your GitHub username in a newline.
+
+All Pull Requests must follow the Pull Request Template, with a title formatted like such `[Project Name]: <Descriptive Title>`
+
 
-https://pitne-voter.netlify.app