GitHub Lite is a simplified web application that allows users to explore GitHub profiles, discover repositories, and interact with basic user data. It provides a minimalistic interface to quickly access GitHub information without the clutter. Explore GitHub profiles. Like your favorite profiles. View your liked profiles. Simple and easy to use.
- React
- React Router
- Magic UI
- React Icons
- Lucide React
- React Hot Toast
- Vite (Build tool for React)
- Tailwind CSS (Styling)
- SCSS (Styling)
- Express.js
- OAuth (GitHub Authentication)
- MongoDB (Database)
- Mongoose (Object Modeling for MongoDB)
-
User Profile Exploration: Explore GitHub profiles by entering a GitHub username.
-
Repository Viewing: View repositories associated with a GitHub user.
-
Profile Like: Like GitHub profiles to keep track of your favorite users.
-
Like History: View a list of profiles you've liked.
-
Repository Sorting: Sort repositories based on criteria like Most Recent, Most Stars, Most Forks, etc.
-
Explore Page: Discover popular repositories from multiple users.
-
Clone the repository:
git clone https://github.com/ZeeshanMukhtar1/GitHub-Lite.git
-
Install dependencies:
cd client npm install cd server npm install
-
Set up environment variables: Create a
.env
file in theserver
directory, the sample file is provided as.env.sample
in theserver
directory for reference. -
Run the application:
npm run dev
-
Access the application at
http://localhost:3000
in your browser. -
Explore GitHub profiles and repositories.
-
Like profiles to create a list of favorite users.
To access the Explore Page and Like History features, authentication via GitHub is required. Please log in to GitHub to access these features.
Contributions are welcome! If you find any issues or have suggestions for improvements, please raise an issue or submit a pull request. We welcome all contributions that help us improve the application. Please follow the Contribution Guidelines before making a contribution.
GitHub Lite is an open-source project. Feel free to contribute, fork, or use the code as per the terms of the MIT License. Your contributions are valuable and appreciated.