ankit-mishra07 / github-search

GitHub User Search

Want to see live preview »

✧ Report Bug ✧ Getting Started ✧ Installing ✧ Author ✧

Glad to share that I created a website called GitHub User Search where user can see their repositories and profile details as well as search for other GitHub user to see their profile details, repositories & many more. Site is fully responsive for all screen with light and dark mode option.

Landing Page:

Here user will get the option for login with his GitHub username with search functionality for username.

Home Page:

Initially after login user can see their repositories, followers profile and self profile with all profile data. After search for any GitHub user, user can see their repositories and profile data as well.

Getting Started

This project was built using React v 18.1.0, Redux v 4.2.0, Material UI, CSS and Rest API. It is a web application and for running on your local environment you should follow these guidelines.

Prerequisites

• NPM

Setup

The project repository can be found in GitHub link or just clone the project using this command.

Using HTTPS

# git clone  https://github.com/Ankit-Mishra07/github-search.git

• Open terminal on your workspace with

cd /home/workspace/github-search/client

Install

Install NPM

Check that you have node and npm installed

To check if you have Node.js installed, run this command in your terminal:

node -v

To confirm that you have npm installed you can run this command in your terminal:

npm -v

To install all the dependences of the project, run the following command:

npm install

To run the application, run the following command:

npm start

Tools used on this project

• Visual Studio Code

Author

👤 Ankit Mishra

• Github: @Ankit-Mishra07
• Linkedin: @ankit-mishra07

🤝 Contributing

This project was created for educational purposes as part of the React web development curriculum; contributing is not accepted.

Show your support

Give a ⭐️ if you like this project!