Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/EddieHubCommunity/good-first-issue-finder

Issue-Crawler for GitHub based on Sveltekit
https://github.com/EddieHubCommunity/good-first-issue-finder

hacktoberfest svelte sveltekit tailwind typescript

Last synced: about 1 month ago
JSON representation

Issue-Crawler for GitHub based on Sveltekit

Host: GitHub
URL: https://github.com/EddieHubCommunity/good-first-issue-finder
Owner: EddieHubCommunity
License: mit
Created: 2022-01-20T08:06:42.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-08-03T08:44:11.000Z (4 months ago)
Last Synced: 2024-08-03T09:42:45.802Z (4 months ago)
Topics: hacktoberfest, svelte, sveltekit, tailwind, typescript
Language: Svelte
Homepage: https://finder.eddiehub.org
Size: 2.63 MB
Stars: 509
Watchers: 7
Forks: 319
Open Issues: 46
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-ccamel - EddieHubCommunity/good-first-issue-finder - Issue-Crawler for GitHub based on Sveltekit (Svelte)
awesome-sveltekit - [code

README

        [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/EddieHubCommunity/good-first-issue-finder)\

[![RepoRater](https://repo-rater.eddiehub.org/api/badge?owner=EddieHubCommunity&name=good-first-issue-finder)](https://repo-rater.eddiehub.org/rate?owner=EddieHubCommunity&name=good-first-issue-finder)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/EddieHubCommunity/good-first-issue-finder?style=plastic)

![GitHub contributors](https://img.shields.io/github/contributors/EddieHubCommunity/good-first-issue-finder)

[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=plastic&logo=discord&logoColor=white)](https://discord.com/invite/jZQs6Wu)

# 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](https://github.com/user-attachments/assets/093b84ac-0fb8-43ab-aa55-0992a01d8fc5)

## 👨‍💻 Live Version

Check out the website: [Good First Issue Finder](https://finder.eddiehub.org)

## 👇 Prerequisites

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

- [Git](https://git-scm.com/downloads)

- [NodeJs](https://nodejs.org/en/download/)

## 🛠️ Installation Steps

1. Fork the project [here](https://github.com/EddieHubCommunity/good-first-issue-finder/fork)

2. Clone the project

   ```bash

     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](https://nodejs.org/en/)

   OR

   By following commands from [Here](https://www.geeksforgeeks.org/how-to-update-node-js-and-npm-to-next-version/)

   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](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app).

> 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.



7. Run `npm run dev`

Alternatively, skip all the steps by using [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/EddieHubCommunity/good-first-issue-finder)

> **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](https://playwright.dev/) for running End-To-End Tests.

For running the tests you would need to install the playwright dependencies by running

```bash

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](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](https://contrib.rocks/image?repo=EddieHubCommunity/good-first-issue-finder)](https://github.com/EddieHubCommunity/good-first-issue-finder/graphs/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](https://github.com/EddieHubCommunity/good-first-issue-finder/blob/main/CODE_OF_CONDUCT.md).