Skip to content

eclectic-coding/rails_congress_app

Repository files navigation

Rails Congress App

"US Capital Building"

ruby version rails version GitHub license GitHub issues Twitter

*Rails Congress is a public information application about the US Congress, both House and Senate. This application started as a simple abstraction of the ProPublica Congress API, However, there are plans to expand this project even further. You can visit the live web site Your Congress to try it out.

If you are interested in contributing to this project, check out the CONTRIBUTORS Guide, and the open Issues.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. Make sure you have the version of Ruby and Rails noted in the badges above on your system.

Installing

Clone this repository to your computer:

git clone https://github.com/eclectic-coding/rails_congress_app

Prerequisites This app uses the Propublica Congress API. You will need to apply for an API key, then add to Rails Credentials:

rails credentials:edit

Add your API key: propublica_api_key: YOUR API KEY

Install the gem files: bundle install

Install the javascript packages: yarn install

This project uses foreman to start both rails server and webpack for a smoother expereince. To start the project: foreman start.

Running the tests

Explain how to run the automated tests for this system

TODO:

  • Rake tasks for Database updates with whenever gem
  • Add Bills section
  • Add Nomination section
  • Add Committee section
  • Add Statements section
  • Add Lobbying section

Check the Open issues to help.

Contributing

Please read CONTRIBUTING.md for details about the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published