Github Compare is a web application that allows users to show comparisons of repositories selected by them on Github.
This App uses github GitHub API V3
Clone this project and install the dependencies:
git clone https://github.com/filipemelo2002/github-compare.git
cd github-compare
npm install # or yarn install
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Below, you can see how the files are organized:
github-compare/
┣ public/
┃ ┣ favicon.ico
┃ ┣ index.html
┃ ┣ logo192.png
┃ ┗ logo512.png
┣ src/
┃ ┣ @types/
┃ ┣ __tests__/
┃ ┣ api/
┃ ┣ assets/
┃ ┣ components/
┃ ┣ pages/
┃ ┣ redux/
┃ ┣ services/
┃ ┣ styles/
┃ ┣ App.tsx
┃ ┣ index.tsx
┃ ┗ react-app-env.d.ts
┣ .eslintrc.json
┣ .gitignore
┣ .prettierrc
┣ README.md
┣ package.json
┣ tsconfig.json
┗ yarn.lock
Are inside components folder and each of them work individually.
currently, there's only one page, Home, which is responsible for rendering all components.
Are declared inside __tests__ folder.
The MIT License (MIT)