Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.68 KB

README.md

File metadata and controls

50 lines (31 loc) · 1.68 KB
Raw

MyRepInfo

License

Table of Contents

Description
Installation
Usage
Contributing
Tests
Questions
License

Description

Client-side repo of MyRepInfo project; quickly look up and access info regarding your congressional representatives

Installation

  • Clone the repository
  • Run npm i to install dependencies
  • Launch the React app using npm run start

Usage

Users do not need to install anything to utilize MyRepInfo. The production app can be found at https://MyRepInfo.org

Contributing

There are multiple ways to contribute to MyRepInfo:

  • Open an issue to report a problem or request new feature
  • Contribute code to address any open issue by creating a fork, making changes and opening a merge request
  • Spread the word

MyRepInfo now uses a forking strategy for contributions rather than repository collaborators. All changes merged to the main branch will automatically be deployed to https://staging.myrepinfo.org to be either rolled back or promoted to production manually at a future date

Tests

Test coverage is powered by Jest + RTL and can be found in the src/tests/ directory with a similar structure to the encompassing src/ files. All tests use .test.ts(x) extensions, mock out props and should avoid making any network calls when run

Questions

Maintainer
For further questions, direct emails here

License

This project is covered under The MIT License