Giter VIP home page Giter VIP logo

good-first-issue-finder's Introduction

Open in Gitpod
License: MIT

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.

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

  1. Run npm run dev

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

๐Ÿงช 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 โญ๏ธ.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.