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.
-
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.
To run the project locally, follow these steps:
-
Clone the Repository:
git clone https://github.com/Oscarj-8/github-user-finder.git
-
Navigate to the Project Directory:
cd github-user-finder -
Install Dependencies:
npm install
-
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.
-
Enter a GitHub username in the search bar.
-
Explore the detailed user profile, including repositories, followers, and following information.
-
Vite: A next-generation front-end tooling.
-
React: A JavaScript library for building user interfaces.
-
GitHub API: Access GitHub data programmatically.
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.
This project is licensed under the MIT License.