sarkioja / github-explorer

A React project to consume the Github API

👨‍💻 The Github Explorer

This project is a simple interface to Github API, allowing users to search for any user, see their profiles, repositories and starred repos.

Demo

🛠 Uses

• React 17
• React Hooks
• Webpack / Babel
• Styled Components and Styled Icons
• Axios for requests
• Vercel CI/CD

🚀 Instructions

1. Clone repository content to your machine.
2. Run yarn on terminal to install all dependencies required on package.json.
3. Create a .env file with your Github API personal token. (There's a env.example in root folder)
4. Type yarn start on console to run the project.
5. Open the address http://localhost:8080 on your browser