Skip to content

Latest commit

 

History

History
99 lines (67 loc) · 2.28 KB

README.md

File metadata and controls

99 lines (67 loc) · 2.28 KB

BugYourCongressman Application

An app built to help people contact their congressman about ending qualified immunity in 2020.

The original idea for this project came from a previous app built by Ian Webster. He outlines that project here. This website updates the needed APIs and gives focus to the Civil Rights movement taking place in 2020.

Local Setup

Clone the Repository

git clone [email protected]:frankolson/bugyourcongressman.git
cd trainer-classroom

Build and Serve the Application

Next, you need to build and run the docker image included in the project repository. The -d flag on the docker-compose up will run docker as a background daemon

If you are not familiar with Docker, brush up on it here.

docker-compose build
docker-compose up -d

The application should now be up and running, but you still need to setup the database.

Initialize the Database

Now, you need to create the database and run the migrations.

docker-compose run web rails db:create db:migrate

Stop the Application

To stop the application, run docker-compose down in your project directory

docker-compose down

Running the Test Suite

Unit Tests

docker-compose run web bin/rails test

or

docker-compose run web bash

bin/rails test

System Tests

docker-compose run web bin/rails test:system

or

docker-compose run web bash

bin/rails test:system

Deploy

Pushes to main will trigger a deploy of the main branch to Heroku. If any new migrations are present, those will be run before the new release is deployed.

git push origin main

Contribute

Want to know how to contribute? Checkout the CONTRIBUTING.md and CODE_OF_CONDUCT.md docs. Once you have done that, bugs and feature requests can be found under in GitHub issues.