Documentation finished

README.md

@@ -1,12 +1,31 @@
-# Getting Started with Create React App
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# [🐙Github Compare](https://github.com/filipemelo2002/github-compare)
+Github Compare is a web application that allows users to show comparisons of repositories selected by them on Github.
 
-## Available Scripts
+This App uses github [**GitHub API V3**](https://docs.github.com/en/rest) 
 
-In the project directory, you can run:
+## 📦 Packages
+### Configuration
+* [ESlint](https://eslint.org/)
+* [Prettier](https://prettier.io/)
+* [Typescript](https://www.typescriptlang.org/)
+### CSS
+*  [ClayUI](https://clayui.com/)
+* [styled-components](https://styled-components.com/) 
+## Tests
+* [Jest](https://jestjs.io/)
+* [Testing Library](https://testing-library.com/)
 
-### `yarn start`
+## ⚙️Getting started
+
+
+Clone this project and install the dependencies:
+```bash
+git clone https://github.com/filipemelo2002/github-compare.git
+cd github-compare
+npm install # or yarn install
+```
+### `npm run start`
 
 Runs the app in the development mode.\
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
@@ -29,18 +48,55 @@ Your app is ready to be deployed!
 
 See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
 
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+## 📸Screenshots
+![Screenshot github-compare](https://i.imgur.com/N8J3cdz.png)
+
+![Screenshot github-compare](https://i.imgur.com/RKhMNqE.png)
+
+![Screenshot github-compare](https://i.imgur.com/xE6loky.png)
+
+![Screenshot github-compare](https://i.imgur.com/gBXkS8p.png)
+
+![Screenshot github-compare](https://i.imgur.com/Q3AjysV.png)
+
+## 🧑‍🏭Architecture
+Below, you can see how the files are organized:
+```bash
+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
+```
+### Components
+Are inside components folder and each of them work individually.
+
+### Pages
+currently, there's only one page, Home, which is responsible for rendering all components.
+
+### Tests
+Are declared inside *\_\_tests\_\_* folder.
+
+## 📃 License
+The MIT License (MIT)

public/index.html

@@ -10,34 +10,10 @@
       content="Web site created using create-react-app"
     />
     <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
-    <!--
-      manifest.json provides metadata used when your web app is installed on a
-      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-    -->
-    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
-    <!--
-      Notice the use of %PUBLIC_URL% in the tags above.
-      It will be replaced with the URL of the `public` folder during the build.
-      Only files inside the `public` folder can be referenced from the HTML.
-
-      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
-      work correctly both with client-side routing and a non-root public URL.
-      Learn how to configure a non-root public URL by running `npm run build`.
-    -->
-    <title>React App</title>
+    <title>Github Compare</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>
     <div id="root"></div>
-    <!--
-      This HTML file is a template.
-      If you open it directly in the browser, you will see an empty page.
-
-      You can add webfonts, meta tags, or analytics to this file.
-      The build step will place the bundled scripts into the <body> tag.
-
-      To begin the development, run `npm start` or `yarn start`.
-      To create a production bundle, use `npm run build` or `yarn build`.
-    -->
   </body>
 </html>

src/components/CardRow/styles.ts

@@ -8,8 +8,9 @@ export const CardHeader = styled.div`
   padding-bottom: 5px;
   padding-right: 5px;
   h4 {
+    font-size: 14px;
     margin-left: 4px;
-    font-weight: 600;
+    font-weight: 500;
   }
   section {
     display: flex;