Active Citizen

Table of Contents

• Active Citizen
  • Table of Contents
  • Project Title
  • Project Description
  • What the Project Does
  • Why the Project is Useful
  • Getting Started
  • Need Help
  • Maintainers
  • Technologies Used
  • Hosting
  • API Key Usage
  • License

Project Title

Active Citizen

Project Description

Bay-Area-Hacks-2.0 is a web application designed to provide citizens with information about local elections and their representatives. The project aims to empower active citizens by making it easier to find and understand the upcoming elections and the officials in their area.

What the Project Does

• Find Local Elections: Users can enter their address to find information about upcoming local elections, including the location, position, and website for more details.
• View Current Officials: The application displays a list of current officials, including their office and name.
• Responsive Design: The web application is designed to be responsive, ensuring a seamless experience across different devices.

Why the Project is Useful

This project is useful for citizens who want to stay informed about local elections and the representatives in their area. It simplifies the process of finding election information and provides a user-friendly interface to access this data.

Getting Started

To run the project locally, follow these steps:

1. Clone the repository to your local machine.
2. Open the index.html file in your preferred web browser.

Need Help

If you encounter any issues or have questions, please feel free to open an issue on the project's GitHub repository.

Maintainers

This project is maintained by Varun Wallajabad, Chris Abiprojo, Gunnika Singh, Vignesh Modigunta. Contributions are welcome! Please feel free to submit a pull request or open an issue if you find any bugs or have suggestions for improvements.

Technologies Used

• HTML: Used for structuring the content of the web application.
• CSS: Used for styling the web application, ensuring a visually appealing and user-friendly interface.
• JavaScript: Used for adding interactivity to the web application, such as fetching data from the Google Civic Information API and dynamically updating the page content.
• Bootstrap: A popular CSS framework used for responsive design and styling.
• Google Maps API: Utilized for the address autocomplete feature, allowing users to easily find their location.
• Google Civic Information API: Used to fetch data about local elections and representatives.

Hosting

The project is hosted on Firebase, providing a fast, reliable, and secure hosting solution. You can access the live application here.

API Key Usage

Please note that the project uses an API key for accessing the Google Civic Information API and Google Maps API. For security reasons, you must replace the API key in every occurrence where it's mentioned in the project files. The API key is mentioned in the following files:

• ./server/test.js
• ./src/index.html
• ./src/script.js

License

This project is licensed under the MIT License. See the LICENSE file for details.