-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #73 from codernotme/main
Updated README.md
- Loading branch information
Showing
1 changed file
with
100 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,145 @@ | ||
| <h1 align="center"> | ||
| Easy Fix | ||
| ⚡️ Easy Fix ⚡️ | ||
| </h1> | ||
|
|
||
| <p align="center"> | ||
| The ideal platform to find beginner-friendly issues. <br /> Designed to inspire and encourage individuals to initiate their contributions to the open source community. | ||
| <i>The ideal platform to find beginner-friendly issues.</i><br /> | ||
| Designed to inspire and encourage individuals to start contributing to the open source community. | ||
| </p> | ||
|
|
||
| <!-- <p align="center"> | ||
| <p align="center"> | ||
| <!-- Badges --> | ||
| <a href="https://choosealicense.com/licenses/mit/"> | ||
| <img src="https://img.shields.io/badge/License-MIT-brightgreen"/ > | ||
| <img src="https://img.shields.io/badge/License-MIT-brightgreen?style=for-the-badge" alt="License Badge"/> | ||
| </a> | ||
| <img src="https://img.shields.io/badge/Version-1.3.1-blue"/ > | ||
| <img src="https://img.shields.io/badge/Version-1.3.1-blue?style=for-the-badge" alt="Version Badge" /> | ||
| <img src="https://img.shields.io/github/stars/vatsalsinghkv/easy-fix?style=for-the-badge" alt="Stars Badge" /> | ||
| <img src="https://img.shields.io/github/forks/vatsalsinghkv/easy-fix?style=for-the-badge" alt="Forks Badge" /> | ||
| <img src="https://img.shields.io/twitter/follow/vatsalsinghkv?style=for-the-badge" alt="Twitter Follow Badge" /> | ||
| </p> | ||
| --> | ||
|
|
||
| [](https://easy-fix.vercel.app/) | ||
| <p align="center"> | ||
| <a href="https://easy-fix.vercel.app/"> | ||
| <img src="https://user-images.githubusercontent.com/68834718/258658579-017bd2d3-20ab-4fa5-bac4-f67d671a70ea.png" alt="Easy Fix Preview" width="80%"/> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## Built With | ||
| --- | ||
|
|
||
| - [React.js](https://react.dev/) | ||
| - [TailwindCSS](https://tailwindcss.com/) | ||
| - [Github API](https://docs.github.com/en/rest) | ||
| - [Vitest](https://vitest.dev/) - Testing library | ||
| - [Iconify](https://icon-sets.iconify.design/) - Icon library | ||
| ## ⚙️ Built With | ||
|
|
||
| ## Contributing | ||
| <p align="center"> | ||
| <a href="https://react.dev/"><img src="https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB" alt="React Badge"/></a> | ||
| <a href="https://tailwindcss.com/"><img src="https://img.shields.io/badge/TailwindCSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white" alt="TailwindCSS Badge"/></a> | ||
| <a href="https://docs.github.com/en/rest"><img src="https://img.shields.io/badge/GitHub%20API-181717?style=for-the-badge&logo=github&logoColor=white" alt="GitHub API Badge"/></a> | ||
| <a href="https://vitest.dev/"><img src="https://img.shields.io/badge/Vitest-6E56CF?style=for-the-badge&logo=vitest&logoColor=white" alt="Vitest Badge"/></a> | ||
| <a href="https://icon-sets.iconify.design/"><img src="https://img.shields.io/badge/Iconify-000000?style=for-the-badge&logo=iconify&logoColor=white" alt="Iconify Badge"/></a> | ||
| </p> | ||
|
|
||
| **Join Our Discord:** [https://discord.gg/St2dHg9YwA](https://discord.gg/St2dHg9YwA) | ||
| --- | ||
|
|
||
| Remember, Good PR makes you a Good contributor ! | ||
| ## 💡 How to Contribute | ||
|
|
||
| ### 1. Setting up the project locally | ||
| Join us and contribute to the project! | ||
|
|
||
| **To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [yarn](https://yarnpkg.com) installed on your computer)** | ||
| [](https://discord.gg/St2dHg9YwA) | ||
|
|
||
| 1. Fork this repository and clone the project | ||
| ### 1. Local Setup | ||
|
|
||
| ```bash | ||
| git clone https://github.com/<YOUR USERNAME>/easy-fix.git | ||
| ``` | ||
| To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) installed. | ||
|
|
||
| 2. Go to the project directory | ||
| 1. Fork the repository and clone the project: | ||
| ```bash | ||
| git clone https://github.com/<YOUR-USERNAME>/easy-fix.git | ||
| ``` | ||
|
|
||
| ```bash | ||
| cd easy-fix | ||
| ``` | ||
| 2. Go to the project directory: | ||
| ```bash | ||
| cd easy-fix | ||
| ``` | ||
|
|
||
| 3. Install dependencies | ||
| 3. Install dependencies: | ||
| ```bash | ||
| yarn | ||
| ``` | ||
|
|
||
| ```bash | ||
| yarn | ||
| ``` | ||
| 4. Start the development server: | ||
| ```bash | ||
| yarn dev | ||
| ``` | ||
|
|
||
| 4. Start the server | ||
| To change the **configuration**, edit the file: `src/lib/utils/config.js`. | ||
|
|
||
| ```bash | ||
| yarn dev | ||
| ``` | ||
| ### 2. Contributing Guidelines | ||
|
|
||
| - To change the **configuration**, edit `src/lib/utils/config.js` | ||
| Follow the [Contributing Guidelines](/CONTRIBUTING.md) for submitting issues or pull requests. | ||
|
|
||
| ### 2. Contributing Guidelines | ||
| --- | ||
|
|
||
| - [Contributing Guidelines](/CONTRIBUTING.md) to be followed. | ||
| ## 🌟 Key Features | ||
|
|
||
| ## The Process | ||
| - **Data Fetching:** App fetches the relevant issues from the GitHub API. | ||
| - **Pagination:** Displays a specific number of issues per page for better navigation. | ||
| - **Filter:** Users can filter issues by programming languages and other labels. | ||
|
|
||
| ### User Stories | ||
| --- | ||
|
|
||
| - As a user, I want to be able to find easy issues with labels like `good-first-issue` and `easy`. | ||
| - As a user, I want to filter issues based on programming languages. | ||
| - As a user, I want to view the labels associated with a specific issue. | ||
| - As a user, I want to view key information about the repository related to a specific issue. | ||
| ## 🔄 Future Development | ||
|
|
||
| ### Features | ||
| - [ ] Add more advanced filters, like filtering by labels and difficulty levels. | ||
| - [x] Migrate the project to TypeScript. | ||
| - [ ] Write more comprehensive test cases to ensure robustness. | ||
|
|
||
| - **Data Fetching:** App fetches the relevant issues from api. | ||
| - **Pagination:** App renders the specific number of issues per page. | ||
| - **Filter:** App fetches the required issues according to the selected language. | ||
| --- | ||
|
|
||
| ### Work Flow | ||
| ## 🛠 The Process | ||
|
|
||
| [](https://lucid.app/lucidchart/e6e01616-e79e-4819-bc64-a23cbbe53944/edit?viewport_loc=-412%2C-279%2C2727%2C1582%2C0_0&invitationId=inv_f6a6111b-2916-409c-8bb6-53ce6a182e44) | ||
| <p align="center"> | ||
| <a href="https://lucid.app/lucidchart/e6e01616-e79e-4819-bc64-a23cbbe53944/edit?viewport_loc=-412%2C-279%2C2727%2C1582%2C0_0&invitationId=inv_f6a6111b-2916-409c-8bb6-53ce6a182e44"> | ||
| <img src="https://user-images.githubusercontent.com/68834718/258657790-fd1b7ba5-2171-4b51-b49a-afefaa68b9c5.png" alt="Easy Fix Work Flow Diagram" width="80%"/> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## Continuous Development | ||
| --- | ||
|
|
||
| - [ ] Add more filters such as filter by labels. | ||
| - [x] Migrate to typescript | ||
| - [ ] Add test cases | ||
| ## 🎉 Current Contributors | ||
|
|
||
| ## Current Contributors | ||
| <p align="center"> | ||
| <a href="https://github.com/vatsalsinghkv/easy-fix/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=vatsalsinghkv/easy-fix" alt="Contributors" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| <a href="https://github.com/vatsalsinghkv/easy-fix/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=vatsalsinghkv/easy-fix" /> | ||
| </a> | ||
| ## 📬 Contact | ||
|
|
||
| ## Contact | ||
| Feel free to reach out for any questions or suggestions: | ||
|
|
||
| <p align="center"> | ||
| <a href="https://vatsalsinghkv.vercel.app"><img src="https://img.shields.io/badge/Website-%23000000.svg?style=for-the-badge&logo=About.me&logoColor=white" alt="Website Badge"/></a> | ||
| <a href="https://github.com/vatsalsinghkv"><img src="https://img.shields.io/badge/GitHub-%23121011.svg?style=for-the-badge&logo=github&logoColor=white" alt="GitHub Badge"/></a> | ||
| <a href="https://www.linkedin.com/in/vatsalsinghkv/"><img src="https://img.shields.io/badge/LinkedIn-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn Badge"/></a> | ||
| <a href="https://twitter.com/vatsalsinghkv"><img src="https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white" alt="Twitter Badge"/></a> | ||
| <a href="https://instagram.com/vatsalsinghkv"><img src="https://img.shields.io/badge/Instagram-%23E4405F.svg?style=for-the-badge&logo=instagram&logoColor=white" alt="Instagram Badge"/></a> | ||
| </p> | ||
|
|
||
| - Discord - [https://discord.gg/St2dHg9YwA](https://discord.gg/St2dHg9YwA) | ||
| - Website - [vatsalsinghkv.vercel.app](https://vatsalsinghkv.vercel.app) | ||
| - Github - [@vatsalsinghkv](https://github.com/vatsalsinghkv) | ||
| - LinkedIn - [@vatsalsinghkv](https://www.linkedin.com/in/vatsalsinghkv/) | ||
| - Twitter - [@vatsalsinghkv](https://www.twitter.com/vatsalsinghkv) | ||
| - Instagram - [@vatsalsinghkv](https://www.instagram.com/vatsalsinghkv) | ||
| --- | ||
|
|
||
| ## Acknowledgements | ||
| ## 🙌 Acknowledgements | ||
|
|
||
| - [https://goodfirstissue.dev/](https://goodfirstissue.dev/) - Design Inspiration | ||
| - [https://brittanychiang.com/](https://brittanychiang.com/) - Design Inspiration | ||
| We’d like to thank the following resources and inspirations for helping us build **Easy Fix**: | ||
|
|
||
| ## Show Your Support | ||
| - **[goodfirstissue.dev](https://goodfirstissue.dev/)** for inspiring our issue-finding process. | ||
| - **[Brittany Chiang](https://brittanychiang.com/)** for inspiring the overall design and layout of the app. | ||
| - **Open-source contributors** whose projects, libraries, and tutorials have helped us along the way. | ||
|
|
||
| Give a ⭐️ if you liked this project! | ||
| --- | ||
|
|
||
| ## ❤️ Show Your Support | ||
|
|
||
| If you find this project helpful, give it a ⭐️ and support open-source development! | ||
|
|
||
| <p align="center"> | ||
| <img src="https://media.giphy.com/media/3ohzdIuqJoo8QdKlnW/giphy.gif" width="200"/> | ||
| </p> |