Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikhilmandaliya/githubfinder
https://github.com/nikhilmandaliya/githubfinder
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/nikhilmandaliya/githubfinder
- Owner: NikhilMandaliya
- Created: 2022-08-06T13:09:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-21T09:46:02.000Z (about 1 year ago)
- Last Synced: 2023-10-21T10:30:21.717Z (about 1 year ago)
- Language: JavaScript
- Size: 348 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Finder
Welcome to the GitHub Finder project, a collaborative effort between two friends, aimed at learning React through the creation of a user profile search tool.
GitHub Finder utilizes React, Tailwind CSS, DaisyUI, and the GitHub API to fetch and display user details.
With GitHub Finder, you can easily search for GitHub users and view their profiles. This project provides a user-friendly interface for exploring GitHub user information.
## Project Details
### Live Link
You can check the live version of the project [here](https://github-finder-nik.netlify.app/).
### Key Project Technologies
- **React:** GitHub Finder is built using React, allowing for the creation of dynamic and interactive user interfaces.
- **Tailwind CSS:** Tailwind CSS is used for styling the project, making it easy to design a clean and modern user interface.
- **DaisyUI:** DaisyUI is incorporated to enhance the capabilities of Tailwind CSS, providing additional utility classes for an efficient development process.
- **GitHub API:** The GitHub API is used to fetch and display user details, ensuring up-to-date and accurate information.
## Getting Started
To run the GitHub Finder project locally, follow these steps:
1. Clone this repository to your local machine:
```bash
git clone https://github.com/NikhilMandaliya/GitHubFinder.git
```
2. Navigate to the project directory:
```bash
cd GitHubFinder
```
3. Install project dependencies:
```bash
npm install
```
4. Start the React application:
```bash
npm start
```
5. Open your web browser and visit http://localhost:3000 to access the GitHub Finder application.
### Learning Goals
This project was a valuable learning experience, and here's what we have gained from it:
- Improved React development skills, including components, state management, and API integration.
- Hands-on experience with Tailwind CSS and DaisyUI for modern and efficient styling.
- Practical use of a real API, demonstrating how to fetch and display data in a React application.
## Contributors
This GitHub Finder project was created and maintained by:
- [Nikhil Mandaliya](https://github.com/NikhilMandaliya)
- [Nikhil Solanki](https://github.com/nikhilso1anki)
We both worked together to learn and build this project, contributing to its development and success.