diff --git a/README.md b/README.md index 4a2751f..9e4ea85 100644 --- a/README.md +++ b/README.md @@ -1,114 +1,145 @@
- 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.
+ + + +
-## 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 + -**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/+ + + +
-## Continuous Development +--- -- [ ] Add more filters such as filter by labels. -- [x] Migrate to typescript -- [ ] Add test cases +## 🎉 Current Contributors -## Current Contributors ++ + + +
+ +--- - - - +## 📬 Contact -## Contact +Feel free to reach out for any questions or suggestions: + + -- 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! + ++ +