A React-based application for viewing GitHub profiles, created using Vite. This application allows users to search for GitHub profiles, view profile details, repositories, followers, and following lists. It also includes a dark mode toggle for a better user experience.
Check out the live demo of the application here.
- Profile Search: Search for GitHub profiles by username.
- Profile Details: View user details including avatar, name, bio, location, and company.
- Repositories: List all public repositories of the user with details like stars and forks.
- Followers & Following: Display the list of followers and users the profile is following.
- Suggestions: Get username suggestions as you type.
- Dark Mode: Toggle between light and dark themes.
- React: JavaScript library for building user interfaces.
- Vite: Next generation frontend tooling for faster builds.
- Axios: Promise-based HTTP client for making API requests.
- Lodash.debounce: Utility for debouncing API calls.
- Tailwind CSS: Utility-first CSS framework for styling.
- Node.js (>=14.0.0)
- npm (>=6.0.0) or yarn (>=1.22.0)
-
Clone the repository:
git clone https://github.com/notnotdurgesh/Github-Profile-Viewer.git cd Github-Profile-Viewer -
Install dependencies:
npm install # or yarn install
Start the development server:
npm run dev
# or
yarn devOpen your browser and visit http://localhost:3000 to see the application in action.
To build the project for production, run:
npm run build
# or
yarn buildThis will create an optimized build of the application in the dist folder.
You can deploy the contents of the dist folder to any static site hosting service, such as Vercel, Netlify, GitHub Pages, etc.
- Enter a GitHub username in the input field.
- Get suggestions as you type.
- Select a suggestion or press the search button to fetch and display the user's profile data.
- Toggle between light and dark mode using the button in the header.
Contributions are welcome! Please open an issue or submit a pull request for any changes or improvements.
This project is licensed under the MIT License. See the LICENSE file for more details.