/initiate-co-api

Primary LanguagePython

Initiate Colorado - Backend - API

Initiate Colorado is the final Capstone project for Front End and Back End Module 4 students at the Turing School of Software and Design. The idea behind the project was to build an application that allowed a user to walk through the steps of filing an initiative to appear on the ballot for the upcoming election in Colorado. The main goals of this project were to use an agile development process in which our team would set goals and deadlines in order to reach a Minimum Viable Product, implement technologies that have not been explicitly taught at Turing, and develop a "full stack" application in which Back End and Front End teams would have to work together to produce one cohesive application.

This repository holds the "Stretch Goal" for the backend team. We primaryly have been focusing on learning Ruby on Rails, so for this portion we challenged ourselves with learning Python and building a webscraper.

Contributors

Alex Eickelman

Charles Wefso

Danny Ramos

Mariana Cid

Michelle Foley

Rostam Mahabadi

Back End Technologies Used

  • Python/ Flask Webscraper

  • Jupyter

  • Regex

  • Jest testing library

  • Github Projects to track stories and progress

Installing / Getting started

To view the deployed version of our application, go to the following link:

https://initiate-co-app.herokuapp.com/

To view this application in development mode and run tests, follow these steps:

Clone down this repo and change into the newly created directory:

git clone https://github.com/Initiate-Colorado/initiate-co-api.git

cd initiate-co-api

Once inside the code base, in order to run tests, type the following command in the terminal:

npm install
npm run setup

If you would like to view the application "scrape" Ballots and the Ballot Process Dates, run:

flask run

Then copy and paste the Localhost provided in the terminal.

Sample of response:

ballotData [
  {
    ballotNumber: '76',
    ballotTitle: 'Citizenship Qualification of Electors* '
  },
  { ballotNumber: '107', ballotTitle: 'Restoration of Gray Wolves* ' },
  {
    ballotNumber: '120',
    ballotTitle: 'Prohibition on Late-Term Abortions* '
  },
  {
    ballotNumber: '257',
    ballotTitle: 'Local Voter Approval of Gaming Limits in Black Hawk, Central City, and Cripple Creek* '
  },
  {
    ballotNumber: '283',
    ballotTitle: 'Paid Family and Medical Leave Insurance Program* '
  },
  {
    ballotNumber: '295',
    ballotTitle: 'Voter Approval Requirement for Creation of Certain Fee-Based Enterprises* '
  },
  {
    ballotNumber: '306',
    ballotTitle: 'State Income Tax Rate Reduction* '
  },

In action!

Signing up as a new user:

login

Initial steps of filing an initiative:

steps