Git Begin

Git Begin is a web application designed to help developers find and track their first open-source contributions. It simplifies the process of discovering "good first issues" across various projects and technologies.

Live

https://gitbegin.theenthusiast.dev

Features

• Find "good first issues" on GitHub (GitLab integration coming soon)
• Filter issues by programming language, star count, and assignment status
• Browse issues by category (Web Dev, Mobile Dev, Data Science, ML, DevOps, Cybersecurity, Documentation)
• Search for issues in specific frameworks or libraries
• Bookmark interesting issues for later (stored in localStorage)
• Dark/Light mode toggle for comfortable browsing

Tech Stack

• Remix.js
• React
• Tailwind CSS
• ShadCN UI

Getting Started

Prerequisites

• Node.js (v14 or later)
• npm or yarn

Installation

1. Clone the repository:

   git clone [https://github.com/your-username/git-begin.git](https://github.com/The-Enthusiast-404/git-begin.git)
   

2. Navigate to the project directory:

   cd git-begin
   

3. Install dependencies:

   npm install
   

   or

   yarn install
   

4. Create a .env file in the root directory and add your GitHub API key:

   GITHUB_API_KEY=your_github_api_key_here
   

5. Start the development server:

   npm run dev
   

   or

   yarn dev
   

6. Open your browser and visit http://localhost:5173

Usage

1. Use the filters on the left sidebar to narrow down issues by language, star count, or category.
2. Click on an issue to view more details.
3. Use the bookmark button to save interesting issues for later.
4. Toggle between light and dark mode using the theme switch in the top right corner.

Contributing

We welcome contributions to Git Begin! Please follow these steps:

1. Fork the repository
2. Create a new branch: git checkout -b feature/your-feature-name
3. Make your changes and commit them: git commit -m 'Add some feature'
4. Push to the branch: git push origin feature/your-feature-name
5. Submit a pull request

Please read our Contributing Guidelines for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Thanks to all the open-source projects that make Git Begin possible.
• Special thanks to the GitHub API for providing access to issue data.

Contact

Email - issahil404@gmail.com