Github Fight

Description   |    Getting Started   |    What's inside?   |    License

under construction...

📋 Description

A simple way to compare Github Reactions. 😃

🚀 Getting Started

1. Download the repository

• Using Git

  git clone https://github.com/codigofalado/github-fight.git

• Using Github CLI

  gh repo clone codigofalado/github-fight

💡 or whichever way you prefer

2. Installation

Inside the repo folder, run yarn or npm install command to install the dependencies.

3. Execution

run yarn start or npm start command to start a local server and get a test! 🚀

💡 If you use another package manager, run the reference commands for install the dependencies and execute the start script on package.json

🧐 What's inside?

🏗️ Technologies

• Gatsby
• ReactJS

💄 Linter tools

• Eslint
• Prettier
• EditorConfig

📦 Packages

• Apollo
• React Helmet
• React Icons
• Styled Compoments
• Polished
• Typeface lato

🗃️ Gatsby plugins

• Manifest
• Netlify
• Netlify cache
• Offline
• Page Creator
• Polished
• Preload Fonts
• React Helmet
• Sharp
• Styled Components

A quick look at the top-level directories inside the ./src.

./src
 ├── @types
 ├── assets
 ├── components
 ├── hooks
 ├── Layout
 ├── pages
 ├── styles

1. assets: all resources used. How icons, images, etc.

2. pages: each folder is a website page.

3. styles: global styles.

📝 License

This project is under the MIT license. See the file LICENSE for more details.

---

Build with 💙 By Henrique Miranda.

Based on the readme template.