Skip to content

Latest commit

 

History

History
97 lines (63 loc) · 4.82 KB

README.md

File metadata and controls

97 lines (63 loc) · 4.82 KB
Raw

Open in Gitpod
License: MIT GitHub code size in bytes GitHub contributors GitHub issues GitHub pull requests GitHub closed pull requests GitHub forks GitHub release (latest by date) 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

👨‍💻 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

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

callback url

  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

  • 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 🍻

Contributors

🙏 Support

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