Skip to content

Oscarj-8/github-user-finder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub User Finder

Welcome to the GitHub User Finder project! This web application is built with Vite + React and utilizes the GitHub API to help you discover and explore GitHub user profiles.

Features

  • User-friendly Interface: A clean and intuitive interface to search and explore GitHub profiles effortlessly.

  • Real-time Data: Utilizes the GitHub API to fetch and display up-to-date information about GitHub users.

  • Responsive Design: Ensures a seamless experience across various devices and screen sizes.

Getting Started

To run the project locally, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/Oscarj-8/github-user-finder.git
    
  2. Navigate to the Project Directory:

    cd github-user-finder
    
  3. Install Dependencies:

    npm install
    
  4. Run the Application:

    npm run dev
    

This will start the development server, and you can access the application at http://localhost:3000 or http://localhost:5173 in your browser.

Usage

  1. Enter a GitHub username in the search bar.

  2. Explore the detailed user profile, including repositories, followers, and following information.

Technologies Used

  1. Vite: A next-generation front-end tooling.

  2. React: A JavaScript library for building user interfaces.

  3. GitHub API: Access GitHub data programmatically.

Contributing

If you'd like to contribute to the project, please follow these steps:

Fork the repository

Create a new branch:

git checkout -b feature/new-feature

Make your changes and commit them:

git commit -m 'Add new feature'

Push to the branch:

git push origin feature/new-feature

Open a pull request.

License

This project is licensed under the MIT License.

About

The GitHub User Finder is a web application developed using Vite and React, designed to streamline the process of discovering GitHub users and exploring their profiles. Leveraging the GitHub API for seamless data retrieval, this project provides an intuitive and efficient platform for users to search, view, and gather information.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors