Home

Awesome

Open in Gitpod
RepoRater GitHub code size in bytes GitHub contributors Discord

Good First Issue Finder by EddieHub

Good First Issue Finder helps new open source contributors to make it easy to get into the world of open source through good first issues.

eddiehub issue finder

<!-- (Can be only done after merged 😅) ## Example using Gitpod, ephemeral dev environment in the cloud (free) ![Gitpod GIF with progress bar](https://user-images.githubusercontent.com/46727048/146048451-ed4ff31a-c178-4713-a9e0-95118be742dc.gif) -->

👨‍💻 Live Version

Check out the website: Good First Issue Finder

👇 Prerequisites

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

🛠️ Installation Steps

  1. Fork the project here

  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. If you encountered error like engine not compatible with your version on node/npm

    Upgrade your node version from Here

    OR

    By following commands from Here

    We highly recommend installing the current LTS version of node.

  6. 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(not GitHub App) in Github to get the required values. See the documentation here. The Callback Url needs to point to the endpoint of the baseURL the app should run on: http://localhost:5173/api/authentication/callback. Also, never commit the .env file, it is ignored by Git.

<img width=450 alt="callback url" src="https://user-images.githubusercontent.com/75534912/191059977-48962f25-4a83-4564-9a17-019ab0783a40.jpg" />
  1. Run npm run dev

Alternatively, skip all the steps by using Gitpod Ready-to-Code

Note: You still need to do the 6th step as defined earlier even if you are using Gitpod to run the app.

🧪 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

<!-- Don't yet have guide, uncomment when we have refer https://github.com/EddieHubCommunity/good-first-issue-finder/issues/79 - Check out our [contribution guidelines](/CONTRIBUTING.md) for more information. -->

🛡️ 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 🍻

Contributors

🙏 Support

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

Our Pledge

We take participation in our community as a harassment-free experience for everyone and we pledge to act in ways to contribute to an open, welcoming, diverse and inclusive community.

If you have experienced or been made aware of unacceptable behaviour, please remember that you can report this. Read our Code of Conduct.