Skip to content

Latest commit

 

History

History
237 lines (147 loc) · 7.28 KB

README.md

File metadata and controls

237 lines (147 loc) · 7.28 KB
Raw

Issue-Finder

A search engine to find newbie-friendly GitHub issues. The issue finder helps you find a list of beginner-friendly GitHub repos, backed by Y Combinator, that have Ruby and Javascript issues that are good for new contributors.

👉 Watch this YouTube video for a quick user's guide!

Your Open Source FinderIssue Finder

Issue Finder Live

Demo

Learn About Issue Finder from the first Contributors

Issue Scraper Logic - Repository Owner

Video: Oscar Mier

React/Redux Logic | API's | Actions - Project Maintainer

Video: Shadman Ali

UI - Project Maintainer

Video: Steve W Dames Jr

Data Retrieval From Github API

Video: Jose Ramon Castaños

API Request from Y Combinator

Video: Ricardo Valtierra

Honorable Mentions:

Firebase Analytics

Linkedin Post: Denis Lafontant

Built With

  • JavaScript
  • REACT
  • REDUX
  • THUNK
  • Tailwind CSS

Milestones

  • Milestone 1: Setup the project and install dependencies

  • Milestone 2: Setup Redux store

  • Milestone 3: Setup thunk

  • Milestone 4: Add label logic

  • Milestone 5: Add filter logic

  • Milestone 6: Create basic UI/UX to display App information

  • Milestone 7: Add Analytics support

  • Milestone 8: Refactor and optimize components/redux

  • Milestone 9: Update Meta for SEO

  • Milestone 10: Deploy live APP

  • Debug linter errors

Screenshots

Cell Desktop

Contribute to Issue Finder

Pre-requisites

  • Code Editor, e.g. VS Code
  • Git and a GitHub account

Getting Started

Getting a local copy of Issue Finder up and running is easy with these following steps.

Clone the repository

In your terminal, navigate to the directory you would like to store the project and run the git-command:

git clone https://github.com/voscarmv/issue-finder.git

After the git-command navigate into the project folder using cd:

cd issue-finder

Now you can open the project in your favorite code editor.

Note

For VS Code you can use the command code . to quickly open projects in the editor.

Install dependencies

After you have cloned the project and have navigated into the project. You need to install the required dependencies using npm, or your perferred package manager:

npm install

Configure your environment

You will also need to create a .env file to later store your GitHub access token in.

Note

The access token is needed for the app to make API calls to GitHub.

touch .env

With the .env file created, you can generate an access token in your settings and add that access token to the REACT_APP_API_KEY variable.

echo REACT_APP_API_KEY=ghp_my_github_token > .env

Your token will start with either ghp_ or github_pat_, depending on if you generated a classic token or a fine-tuned token. Both will work for this application.

Important

The GitHub access token doesn't need any scopes to function.

Run the application

Now that the dependencies are installed and your environment is setup. You can run the application using npm or your perferred package manager:

npm start

Linter Setup

  • Run npx eslint . which will print any errors found.
  • Run npx eslint . --fix to automatically fix the errors.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Usage

  • Select a label from the first drop down menu
  • Select a language from the second drop down menu
  • Click FIND ISSUES to filter through great issues matching your search query
  • Click on a issue from the list of issues below to view your next open source contribution on GitHub

Make some coffee in the time you saved finding an amazing issue for your next contribution!

Author 1:

👤 OSCAR MIER

Author 2:

👤 SHADMAN ALI

Author 3:

👤 STEVE W DAMES JR

Author 4:

👤 JOSE RAMON

Author 5:

👤 RICARDO VALTIERRA

Author 6:

👤 DENIS LAFONTANT

✨ Contributors

Thank you for your commitment and tireless efforts. The value you bring to our team is priceless, and we deeply appreciate your contributions. Your admirable dedication and unwavering commitment are truly commendable. Thanks for all that you do to support our team.

🤝 Contributing

Join our Whatsapp group!

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Hat tip to anyone whose code was used.

📝 License

This project is MIT licensed.