README.md

OpenElect

OpenElect is an open source voting platform which helps government, enterprise, and small organization to hold online elections. The key tenets of OpenElect are security, simplicity, and verifiability. OpenElect utilizes the most advanced cryptography technology and strive to create a plaform where engineers around the world can contribute to make OpenElect better and safer.

Table of Contents

1. Team
2. Usage
3. Technology Stack
4. Requirements
5. Development
   1. Installing Dependencies
   2. Tasks
6. Roadmap
7. Contributing

Team

• Product Owner: [Ryan Carey] (https://github.com/ryyann)
• Technical Lead: [Bradley Portnoy] (https://github.com/bportnoy)
• Scrum Master: [Brian Hsu] (https://github.com/brianpchsu)
• Project Manager: [Rebekah Kwon] (https://github.com/rebekahkwon)

Usage

Use the link to create an account, start an election, and vote. Or clone this repo to develop and extend the original voting system. To run the service: grunt serve

Technology Stack

###BackEnd

• Server Environment: NodeJS
• Web Framework: ExpressJS
• Database: PostgreSQL
• Task Runner: Grunt

###FrontEnd

• Architecture: React & Flux
• User Interface: HTML5/SCSS

###Testing

• Continuous Integration: CircleCI
• Test Runner: Grunt
• Test Framework: Mocha
• Assertion Library: Chai
• Plugin(s): Sinon

###Deployment

• Application Management: AWS Elastic Beanstalk

Requirements

• Node 0.12.x
• PostgreSQL 9.x
• Bower

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
sudo npm install -g nodemon
npm install
bower install
grunt serve

Tasks

From within the root directory:

grunt test

grunt tasks:

• grunt test

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.