github-search-users's Introduction

GitHub User Search Web Project

This is a web project that allows users to search and find GitHub users using the GitHub API. The project is built with HTML, CSS, JavaScript, and Vite as the bundler. Yarn is used as the package manager.

Features

User can enter a GitHub username in the search bar and see a list of matching users.
User can click on a username in the list to see more details about that user.
User can see the user's name, avatar and the number of followers and following.
User can see the user's repositories with the repository
User can click on a repository name to go to that repository on GitHub.

Demo

https://github-search-users-dev.netlify.app/

Prerequisites

In order to run this project, you will need to have the following installed on your computer:

nodejs
yarn | npm

Installation

To install the application, follow these steps:

Clone the repository to your local machine:

git clone https://github.com/Silent-Watcher/Github-search-users

Navigate to the project directory in your terminal.

  cd Github-search-users

Run yarn to install the necessary packages.

  yarn

usage

To start the application, run yarn dev. This will start the application on http://localhost:5173.

  yarn dev

Deployment

To deploy the application, follow these steps:

1.  Create an account on Netlify.
2.  Create a new site in Netlify.
3.  Link the site to your GitHub repository.
4.  Set the build command to `yarn build`.
5.  Set the publish directory to `dist`.
6.  Deploy the site.