Gh Next

Overview:

This project is a simple clone of GitHub developed in Next.js. It aims to provide a functional alternative to GitHub with core features such as login/logout, homepage, settings page, stargazers page, profile information viewing, and more. The project is actively under development, so users should expect some features to break. The roadmap includes various features such as issue management, notifications, file hosting for repositories, repository list, Git web interface, CI/CD integration, and more. The project uses Next App Router, drizzle, local Postgres database, and tailwindCSS for styling.

Features:

• Login/Logout functionality
• Responsive Layout for different screen sizes
• Settings page for toggling themes
• Stargazers Page to view users who have starred a repository
• Profile information viewing
• Update username feature
• Change theme option
• Issue List page for managing issues
• Search & filter issues by various criteria

Installation:

1. Clone the repository:

   git clone [repository_url]
   

2. Start the docker compose instance for the database and Redis:

   docker-compose up
   

3. Install dependencies:

   npm install
   

4. Rename .env.example to .env.local and customize the file as needed.
5. Launch the project:

   npm run dev
   

6. Access the application at http://localhost:3000

Summary:

The GitHub clone project built in Next.js aims to replicate important features of GitHub with an open-source alternative. With a roadmap that includes essential functionalities like issue management, notifications, file hosting, repository list, Git web interface, and CI/CD integration, the project is actively developed and may have some features under construction. Users can contribute to the project by following the provided installation guide and exploring the codebase.