https://github.com/iatenine/octo-spork-client

Quickly access info regarding active members of US congress based on district
https://github.com/iatenine/octo-spork-client

government government-data politics voter-engagement

Last synced: about 2 months ago
JSON representation

Quickly access info regarding active members of US congress based on district

• Host: GitHub
• URL: https://github.com/iatenine/octo-spork-client
• Owner: iatenine
• License: mit
• Created: 2022-07-21T18:09:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-24T01:36:07.000Z (over 1 year ago)
• Last Synced: 2024-06-15T03:19:52.581Z (6 months ago)
• Topics: government, government-data, politics, voter-engagement
• Language: TypeScript
• Homepage: https://MyRepInfo.org
• Size: 1.72 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MyRepInfo

[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# Table of Contents

[Description](#description)  

[Installation](#installation)  

[Usage](#usage)  

[Contributing](#contributing)  

[Tests](#tests)  

[Questions](#questions)  

[License](#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](https://github.com/iatenine)  

For further questions, direct emails [here](mailto:[email protected])

# License

This project is covered under [The MIT License](https://opensource.org/licenses/MIT)