From be7965c580e8ec6e407315fc3e3a36aacded0af3 Mon Sep 17 00:00:00 2001 From: Aryan Date: Sun, 20 Oct 2024 19:32:47 +0530 Subject: [PATCH] Update README.md Enhanced README.md with badges, and improved layout --- README.md | 169 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 100 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 4a2751f..9e4ea85 100644 --- a/README.md +++ b/README.md @@ -1,114 +1,145 @@

-Easy Fix + ⚡️ Easy Fix ⚡️

- The ideal platform to find beginner-friendly issues.
Designed to inspire and encourage individuals to initiate their contributions to the open source community. + The ideal platform to find beginner-friendly issues.
+ Designed to inspire and encourage individuals to start contributing to the open source community.

- - + License Badge - + Version Badge + Stars Badge + Forks Badge + Twitter Follow Badge

- --> -[![Preview](https://user-images.githubusercontent.com/68834718/258658579-017bd2d3-20ab-4fa5-bac4-f67d671a70ea.png)](https://easy-fix.vercel.app/) +

+ + Easy Fix Preview + +

-## 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 +

+ React Badge + TailwindCSS Badge + GitHub API Badge + Vitest Badge + Iconify Badge +

-**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)** +[![Join Discord](https://img.shields.io/discord/702354117747146845?color=5865F2&label=Join%20Our%20Discord&logo=discord&style=for-the-badge)](https://discord.gg/St2dHg9YwA) -1. Fork this repository and clone the project +### 1. Local Setup - ```bash - git clone https://github.com//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//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 -[![Easy Fix work flow diagram](https://user-images.githubusercontent.com/68834718/258657790-fd1b7ba5-2171-4b51-b49a-afefaa68b9c5.png)](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) +

+ + Easy Fix Work Flow Diagram + +

-## Continuous Development +--- -- [ ] Add more filters such as filter by labels. -- [x] Migrate to typescript -- [ ] Add test cases +## 🎉 Current Contributors -## Current Contributors +

+ + Contributors + +

+ +--- - - - +## 📬 Contact -## Contact +Feel free to reach out for any questions or suggestions: + +

+ Website Badge + GitHub Badge + LinkedIn Badge + Twitter Badge + Instagram Badge +

-- 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! + +

+ +