Update README.md

README.md

@@ -3,7 +3,7 @@
 # Boston Voter App
 Collaborators: 
 * Arshnoor Kaur Chadha; Github: @arshnoorKC13
-* Elenaor Elkus; Github: @eelkus01
+* Eleanor Elkus; Github: @eelkus01
 * Jason Jiang; Github: @jasonjiang9142
 
 # Description
@@ -15,28 +15,55 @@ Many news organizations provide articles or voting guides around the election, b
 # 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.
+* Detailed candidate profiles, including 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 in pitne-voter-app
-    * cd..
-    * cd client
-    * npm install
-    * cd ..
-    * cd server
-    * npm install
-    * cd ..
-    * cd strapi 
-    * npm install
-    * cd ..
-* cd client
-* npm run dev
+1. Clone the repository:
+    ```bash
+    git clone https://github.com/BU-Spark/pitne-voter-app.git
+    cd pitne-voter-app 
+    ```
+
+2. Install dependencies:
+    ```bash
+    npm install
+    ```
+
+3. Navigate to the client directory, install dependencies, and start client server
+    ```bash
+    cd client
+    npm install
+    npm run dev
+    ```
+
+4. On another terminal, navigate to the server directory, install dependencies, and start Server:
+    ```bash
+    cd server
+    npm install
+    npm run dev
+    ```
+
+5. On another terminal, navigate to the Strapi directory, install dependencies, and start Strapi server:
+    ```bash
+    cd strapi 
+    npm install
+    npm start
+    
+    ```
+
+
+
+## Environment Variables
+Create a `.env` file in the `server` directory (`cd server`) and add the following environment variables:
+
+```plaintext
+GOOGLE_CIVIC_API_KEY=your_api_key_here
+```
+
 
 # Deployement 
 Access our deployed website through netlify at https://pitne-voter.netlify.app.
@@ -49,9 +76,27 @@ Status of Deployment:
 * 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.
+
+# SnapShots
+
+**Ability to see Upcoming Elections from Strapi CMS input**
+
+<img width="1440" alt="Screenshot 2024-06-28 at 12 12 58 PM" src="https://github.com/BU-Spark/pitne-voter-app/assets/69778744/95c25d88-d41a-4964-975a-efd1a68adaa4">
+
+**Comprehensive List of all possible Voting Options**, including direct links from government websites
+
+<img width="1440" alt="Screenshot 2024-06-28 at 12 14 22 PM" src="https://github.com/BU-Spark/pitne-voter-app/assets/69778744/82d8f3ff-138e-4063-91b1-08c5ae4bd76d">
+
+**Ability to see information about candidates for a selected election and district number**
+
+<img width="1440" alt="Screenshot 2024-06-28 at 12 15 53 PM" src="https://github.com/BU-Spark/pitne-voter-app/assets/69778744/14e4c319-a8d7-4b38-bc06-2ee1644e0e44">
+
+<img width="1440" alt="Screenshot 2024-06-28 at 12 16 07 PM" src="https://github.com/BU-Spark/pitne-voter-app/assets/69778744/11e78484-7ec8-40c2-a44d-45799712b9ed">
+
+<img width="1440" alt="Screenshot 2024-06-28 at 12 16 31 PM" src="https://github.com/BU-Spark/pitne-voter-app/assets/69778744/56e64008-8bcc-40b5-8cbd-ae4ba9896f7b">
 
-All Pull Requests must follow the Pull Request Template, with a title formatted like such `[Project Name]: <Descriptive Title>`
+**Ability to information for all polling locations in Boston and nearest ones for a given address**
 
+<img width="1440" alt="Screenshot 2024-06-28 at 12 17 49 PM" src="https://github.com/BU-Spark/pitne-voter-app/assets/69778744/70f92823-08cc-4a2b-a539-2fb253b3be82">
 
+<img width="1440" alt="Screenshot 2024-06-28 at 12 19 35 PM" src="https://github.com/BU-Spark/pitne-voter-app/assets/69778744/6f1b3dc5-fb7e-44e7-a357-74d6e084fcc3">