Ada's Elections

Automating the election process every year.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

A web application to aid in Ada's Team annual election of the executive team.

• Minimum Viable Product (MVP) is to automate the voting process and block any ineligible voters/votes.
• Deployed Website: https://elections.adasteam.ca/

Built With

• React
• Firebase
• Semantic-UI
• Python

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/adas-team/ElectionsApp.git

2. Install NPM packages

   npm install

Roadmap

See the open issues for a list of proposed features (and known issues).

Election Update Instructions

These instructions allow you to upload the candidate and voter information to the database, as well as upload the candidate photos.

1. Follow the instructions on src/firebase/INSTRUCTIONS.md to update the database with the candidate and voter information.

2. Upload the candidate photos to public/candidatePhotos

3. Update the candidates object in src/components/constants.js

4. Build and deploy to Netlify using CLI

   a. Install Netlify CLI, if not already installed:

   npm install netlify-cli -g

   b. Login to Ada's Team netlify (info in Account Information), if not already logged in

   netlify login # alternatively, use `netlify switch` if signed into another account

   c. Build the project

   npm run build

   d. Deploy the project

   • Use build as the publishing directory
   • If it asks for a site, use adas-team-elections.netlify.app

   netlify deploy --prod

Contributing

Please reference the CONTRIBUTING.md file.

License

Distributed under the GNU General Public License v3.0 license. See LICENSE for more information.

Contact

Ada's Team - @adas_team - [email protected]

Acknowledgements

• Helen Gezahegn
• Xinyue (Rex) Xiang
• Katherine Patenio