/issue-finder

A search engine for newbie-friendly github issues.

Primary LanguageCSSMIT LicenseMIT

Issue-Finder

A search engine for newbie-friendly github issues.

Your Open Source FinderIssue Finder

Issue Finder Live

Demo

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

Getting Started

To get a local copy up and running follow these simple example steps.

Pre-requisites

  • Text Editor | Git and Github set up

Usage

In your terminal, navigate to your current directory and run this code:

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

Then run:

cd issue-finder

Open the project in your favorite code editor code . for VS Code.

Dependencies

  • Run npm install - to load necessary files from package.json
  • Export REACT_APP_API_KEY=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Except with your own key generated here https://github.com/settings/tokens

  • Then in your terminal type npm start and view app in your browser

Linter Setup

  • Apply Linter checks with the following instructions
  • Eslint: To find and fix script errors, run npm install --save-dev eslint@7.x eslint-config-airbnb@18.x eslint-plugin-import@2.x eslint-plugin-jsx-a11y@6.x eslint-plugin-react@7.x eslint-plugin-react-hooks@4.x @babel/eslint-parser@7.x @babel/core@7.x @babel/plugin-syntax-jsx@7.x @babel/preset-react@7.x @babel/preset-react@7.x After, create a .eslintrc.json file. Then run npx eslint . to print errors. Use npx eslint . --fix to fix multiple 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

🤝 Contributing

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.