Skip to content

Create an engaging regulation website so that users can create, store, and look up federal regulations/petitions

Notifications You must be signed in to change notification settings

cmlooff/Federal-Regulation-Project

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Christian Looff Project: The Petitionist

Giving easy access for the public to interact with the Regulation Process!
Explore the docs »
Explore the Project Board »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Product Name Screen Shot

Federal agencies shape the regulatory process, affecting countless aspects of our everyday lives. One of the most important parts of the rulemaking process is the ability of the public to participate. At times, federal agencies fail to develop regulations. A petition for rulemaking is the mechanism by which individuals, public interest groups, and private enterprise can argue in favor of changes or new rules for ensuring the general welfare of the nation.

Here's why:

  • Filing a petition for rulemaking is usually a far more complex and detailed process than commenting on a rule. The Petitionist is here to help with that process!
  • Agencies are in no way required to respond to public opinion, but by demonstrating broad support from a large and/or diverse group of people will help strengthen your argument. We're here to create a community to back your petitions!
  • It's time to take the means of regulation back to the power of the people! 📒 ✒️

(back to top)

Built With

  • MongoDB
  • React
  • Redux
  • React-Router
  • JWT
  • Webpack

(back to top)

Getting Started

Starting Notes

  • Main branch is only for production
  • Dev branch is for development. Two person review process for pull requests to the dev and main branch.

Starting off

  • 1. Clone main repository to local machine
  • 2. git checkout -b [name/feature] -> Create feature branch off main or dev
  • 3. Commit to your local feature branch often!

Pushing changes to the main repo

  • 1. 'Git checkout dev' (locally switch to dev branch)
  • 2. 'Git pull origin dev' (Pull updates of dev down to your local system)
  • 3. 'Git checkout [your branch] (switch back to your branch locally)
  • 4. 'Git merge dev' (Brings dev into your local branch)
  • 5. Resolve conflicts or :q if there aren't any
  • 6. 'Git push origin ' (Push merged branch up to github)
  • 7. Create a pull request in github from ==> dev
  • 8. Repeat as needed
  • 9. When ready to publish main, do step 7 but from dev => main
    git checkout dev
    git pull origin dev
    git checkout <name/feature>
    git merge dev
    // Resolve Merge conflicts
    git push origin <name/feature>
    

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install 

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Christian Looff - @cmlooff

Project Link: https://github.com/cmlooff/Federal-Regulation-Project

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

Create an engaging regulation website so that users can create, store, and look up federal regulations/petitions

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published