Good First Issues

If you are just starting out in Open Source you've come to the right spot! Well... sort of. This is a Search filter for Good-First-Issue tag on GitHub.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The concept is pretty straightforward. The project is accessing the GitHubs API using Octokit. From there we are filtering out 1 random Git Repo with the tag Good-First-Issue.

(back to top)

Built With

• Next.js
• Octokit
• Deployed on Vercel

(back to top)

Getting Started

Here's a few steps to take to get started.

Prerequisites

First thing you're going to need is Node.js This will provide you with npm: Node Package Manager.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Hopelezz/FirstIssuesApp.git

2. Install NPM packages

   npm install

3. Run a localhost instance

   npm run dev

(back to top)

Usage

I intend for this to be for people who are interested in open source. The Good-First-Issue tag on GitHub is a great place to start. Sometimes as a new beginner this can be hard to find. This app is meant to be an easy way to highlight those first issues.

(back to top)

Roadmap

• Input field for filters.
• Background that changes.
• Using SolidJS or Astro instead of Next.js

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request with suggested changes. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch

   git checkout -b feature/AmazingFeature

3. Run this command to install dependencies:

   npm install

   & to run a LocalHost version of the app:

   npm run dev

4. Commit your Changes

   git commit -m 'Add some AmazingFeature'

5. Push to the Branch

   git push origin feature/AmazingFeature

6. Open a Pull Request detailing the changes. Remember this is a great time to show your communication skills!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @Hopelezz1 - [email protected]

Project Link: https://github.com/Hopelezz/FirstIssuesApp

(back to top)

Acknowledgments

• @eddiejaoude For the original project. Please if you have a moment check out his work on EddieHub.
• Leon Noel For his classes on Web Development. Please if you have a moment check out the #100Devs Community on twitter.

(back to top)