GitHub Finder

App to search GitHub users and display their info and repositories, built with React, TypeScript, and Styled Components.

🛠️ Technologies

TypeScript
React
React Router
Styled Components

🔗 Link

Live App URL: GitHub Finder

🌐 API

API used in the project: GitHub REST API

💻 Preview

Desktop

Mobile

💡 Features

✔️ Search for a GitHub user
✔️ View user's details: profile picture, username, location, number of followers and following
✔️ View a list of the user's repositories sorted by stars in descending order, so the most popular repositories appear first
✔️ View information about a repository: name, language, star count, forks count, and link to the repository

⚙️ How to use

To clone and run this project you'll need Node.js and Git installed on your computer. In addition, it is good to have an editor to work with the code like VSCode. Follow the instructions bellow:

# Clone this repository
$ git clone https://github.com/julianachagas/github-finder.git

# Go into the repository
$ cd github-finder

# Install the dependencies
$ npm install

# Run the app in development mode
$ npm run dev

# Build the app for production to the `dist` folder
$ npm run build

# Preview the production build locally
$ npm run preview

julianachagas/github-finder