https://github.com/lakshayd02/githunt_github_finder
Githunt, a sleek and intuitive profile finder website built using ReactJS, the powerful GitHub API, and Semantic UI. With Githunt, users can effortlessly search for GitHub profiles by name or username, gaining insight into users' repositories, followers, and contributions.
https://github.com/lakshayd02/githunt_github_finder
css css3 github-finder-app github-finder-reactjs githubapi html html-css-javascript html5 javascript jsx react reactjs semantic-ui
Last synced: 2 months ago
JSON representation
Githunt, a sleek and intuitive profile finder website built using ReactJS, the powerful GitHub API, and Semantic UI. With Githunt, users can effortlessly search for GitHub profiles by name or username, gaining insight into users' repositories, followers, and contributions.
- Host: GitHub
- URL: https://github.com/lakshayd02/githunt_github_finder
- Owner: LakshayD02
- Created: 2024-03-30T13:50:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-01T11:28:01.000Z (5 months ago)
- Last Synced: 2025-03-24T08:11:13.542Z (3 months ago)
- Topics: css, css3, github-finder-app, github-finder-reactjs, githubapi, html, html-css-javascript, html5, javascript, jsx, react, reactjs, semantic-ui
- Language: JavaScript
- Homepage: https://githunt-lakshay.vercel.app/
- Size: 191 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Githunt - GitHub Profile Finder 🔎
Githunt is a sleek and intuitive profile finder website built using ReactJS, the powerful GitHub API, and Semantic UI. It allows users to effortlessly search for GitHub profiles by name or username, gaining insight into users' repositories, followers, and contributions.
## Description
Githunt simplifies the process of exploring GitHub profiles. Leveraging the official GitHub API, it fetches real-time data, ensuring accurate information about users, their repositories, and activity. The user interface is built with ReactJS for a dynamic and responsive experience, and styled using Semantic UI for a clean and modern look.
**Key Technologies:**
* **GitHub API:** Githunt utilizes the GitHub API to fetch data about GitHub users, including their repositories, followers, and contributions. This API allows Githunt to provide users with real-time and accurate information about GitHub profiles.
* **ReactJS:** React provides the foundation for a dynamic and interactive user experience. It enables efficient updates and rendering of the profile information.
* **Semantic UI:** Githunt leverages Semantic UI, a modern UI framework, to enhance the website's design and user interface. Semantic UI provides a set of pre-designed components and styles, making it easy to create a visually appealing and responsive website.
## Website Features ✨
* **Dark Animation on Home Page:** A visually appealing dark-themed animation greets users on the home page, creating an engaging introduction to the app.
* **GitHub Profile Search:** Easily find GitHub profiles by entering a name or username. Githunt uses the GitHub API to retrieve and display relevant profiles.
* **Detailed Profile Information:** View comprehensive profile details, including repositories, follower counts, following counts, contributions, and more.
* **Responsive Design:** Githunt is fully responsive, ensuring a seamless experience across various devices, from desktops to mobile phones.
* **About the Developer Page:** Learn more about the creator of Githunt on the dedicated "About" page. This page provides information about the developer and the motivation behind the project.
## 🛠️ How to Install and Run:
To get started with **Githunt** on your local machine, follow these steps:
```bash
# 1. Clone the Repository:
git clone [https://github.com/YOUR_USERNAME/Githunt.git](https://www.google.com/search?q=https://github.com/YOUR_USERNAME/Githunt.git) # Replace with the actual repo URL
# 2. Navigate to the Project Directory:
cd Githunt
# 3. Install Dependencies:
npm install # or yarn install
# 4. Start the Development Server:
npm start # or yarn start
# 5. Contributing (Optional but Encouraged!) 🤝
# Contributions are welcome! If you'd like to contribute to Githunt, please follow these steps:
# a. Fork the Repository: Create your own fork of the Githunt repository on GitHub.
# b. Create a Branch: Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name`
# c. Make Changes: Make your changes to the code.
# d. Commit Changes: Commit your changes with a descriptive message: `git commit -m "Add your message here"`
# e. Push Changes: Push your changes to your forked repository: `git push origin feature/your-feature-name`
# f. Create a Pull Request: Submit a pull request to the main Githunt repository.
# We will review your pull request and merge it if it meets the project's standards.