Good First Issue Finder by EddieHub

Good First Issue Finder helps new open source contributors pave their path into the world of open source through good first issues.

👨‍💻 Live Version

Check out the website: Good First Issue Finder

👇 Prerequisites

Before installation, please make sure you have already installed the following tools:

• Git
• NodeJs

🛠️ Installation Steps

1. Fork the project
2. Clone the project

     git clone https://github.com/YOUR_USERNAME/good-first-issue-finder.git
   

3. Navigate to the project directory cd good-first-issue-finder
4. Install dependencies with npm install
5. Create a .env file in the root of the project. Then add your GitHub Oauth values (see example in .env.example file)

Note: You need to set up an Oauth App in Github to get the required values. See the documentation here.
The Callback Url needs to point to the endpoint /api/authentication/callback of the baseURL the app should run on.

6. Run npm run dev

Alternatively, skip all the steps by using

🧪 Testing

We're using Playwright for running End-To-End Tests. For running the tests you would need to install the playwright dependencies by running

npx playwright install --with-deps

👨‍💻 Contributing

• Contributions make the open source community such an amazing place to learn, inspire, and create.
• Any contributions you make are greatly appreciated.

🛡️ License

Good first issue finder is licensed under the MIT License - see the LICENSE file for details.

💪 Thanks to all Contributors

Thanks a lot for spending your time helping Good first issue finder grow. Thanks a lot! Keep rocking 🍻

🙏 Support

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️.