A GitHub clone application built using the MERN stack (MongoDB, Express.js, React.js, Node.js). This project mimics GitHub's functionality, including repositories, user profiles, and authentication.
- User Authentication: Secure login and registration using GitHub OAuth.
- Repository Management: Create, view, and manage repositories.
- User Profiles: View and edit user profiles.
- Real-time Updates: Real-time notifications for repository changes and user activities.
- Frontend: React.js, Tailwind CSS
- Backend: Node.js, Express.js
- Database: MongoDB
- Authentication: GitHub OAuth
- Real-time Communication: Socket.IO (if applicable)
- Node.js and npm installed
- MongoDB instance running (locally or remotely)
- Clone the Repository:
git clone https://github.com/abhishekpaturkar/github-clone.git
- Navigate to the Project Directory:
cd github-clone
-
Setup Backend:
Navigate to the backend directory:
cd backend
Install backend dependencies:
npm install
Create a .env file in the root directory with the following content:
GITHUB_API_KEY=""
MONGO_URL=""
PORT=3000
GITHUB_CLIENT_ID=""
GITHUB_CLIENT_SECRET=""
CLIENT_BASE_URL=""
Start the backend server:
npm start
-
Setup Frontend:
Navigate to the frontend directory:
cd ../frontendInstall frontend dependencies:
npm installStart the frontend development server:
npm run dev -
Open your browser and go to
http://localhost:5173to access the application.
- Authentication: Log in with your GitHub account using OAuth.
- Manage Repositories: Create and manage your repositories.
- View Profiles: Navigate to user profiles to view and edit details.
Contributions are welcome! Please submit issues or pull requests on GitHub.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or support, contact:
- Email: paturkarabhishek03@gmail.com
- GitHub: abhishekpaturkar