stephaniezou1 / be-engaged-backend

An election app that tracks elections across the country, finds the closest polling stations in your city, and sends you SMS notifications for voting deadlines 👀

Ruby on Rails API

• Ruby on Rails API for the Be Engaged backend.
• This API consists of 4 domain models with has_many and belongs_to associations.
• Pulls in election and polling station data from Google Civic Information API.
• Developed SMS notification feature with the Twilio API.
• See frontend Github link here
• Built by Stephanie Zou.

Getting Started

To get started, you will only need Ruby on Rails and Postgres. To do so, you must have Homebrew and Ruby installed first.

Node installation on OS X

In your terminal...

1. Install Homebrew

   $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

2. Install Ruby

   $ brew install ruby

3. Install Rails

   $ gem install rails

4. Install PostgreSQL

   $ brew install postgresql

Installation

1. Clone the repo and cd into the folder

2. Bundle Install

   $ bundle install

3. Create migrations, migrate and seed:

   $ rails db:create
   $ rails db:migrate
   $ rails db:seed
   

Launch The Server

1. Last step, launch the rails server! $ rails s

   Start developing!

Tools

• Rack CORS: description
• ActiveModel::Serializer: description
• Google Civic Information API
• Twilio API

Live demo

Coming soon!