https://github.com/joshaaronlevy/repo-runner
This app lets you search, filter, and view GitHub Repositories
https://github.com/joshaaronlevy/repo-runner
primereact react redux
Last synced: 2 months ago
JSON representation
This app lets you search, filter, and view GitHub Repositories
- Host: GitHub
- URL: https://github.com/joshaaronlevy/repo-runner
- Owner: JoshAaronLevy
- Created: 2022-02-28T01:55:49.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-12T03:07:45.000Z (about 3 years ago)
- Last Synced: 2025-01-19T08:36:31.509Z (4 months ago)
- Topics: primereact, react, redux
- Language: JavaScript
- Homepage:
- Size: 3.52 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
RepoRunner
This app lets you search, filter, and view GitHub Repositories.
## Table of Contents
- [Core Stack](#core-stack)
- [View Live Demo](#view-live-demo)
- [Running the App Locally](#running-the-app-locally)
- [Tests](#tests)
- [In Development](#in-development)
## View Live Demo
A live demo of this project is hosted on Firebase and can be found at [https://repo-runner.web.app/](https://repo-runner.web.app/)
## Core Stack
- React v17
- Redux v7
- [Primereact UI v7](https://www.primefaces.org/primereact)
- [React Router v5](https://v5.reactrouter.com/)
## Running the App Locally
**NOTE:** If you're running the app for the first time, run the following commands:
- HTTPS Clone
1. `git clone https://github.com/JoshAaronLevy/repo-runner.git`
- SSH Clone
1. `git clone [email protected]:JoshAaronLevy/repo-runner.git`
2. `cd repo-runner`
3. `npm i`
- (Optional) Check build succeeds
4. `npm run build`
5. `npm start`
- (Optional) Ensure tests pass with Cypress
6. `npm run e2e`
## Tests
This repo is configured for both integration and end-to-end tests
### Integration tests implemented with `@testing-library/react`
Integration test files can be located in [`src/tests`](src/tests/) folder
**NOTE:** Integration tests currently failing but can be run with the `npm run test` command
### e2e tests implemented with `@cypress/react`
e2e test files can be located in [`cypress/integration/tests`](cypress/integration/tests/) folder
**NOTE:** e2e tests currently succeeding and can be run with the `npm run e2e` command
**NOTE:** Cypress is configured to use `http://localhost:3000` as the baseUrl. To run the e2e tests, you must first have run `npm start`, then run the `npm run e2e` command in a separate terminal
## In Development
Watch this repository in GitHub for the following updates in development:
- e2e testing with [Cypress.io](https://www.cypress.io/)
- Mocks with [Mirage.js](https://miragejs.com/) to add additional unit tests with Jest