diff --git a/README.md b/README.md index b0672ec..ab0984e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,74 @@
-#
SaralSeva
+

SaralSeva

+ +

๐Ÿ“– Table of Contents

+ +- Overview +- Project Insights +- ๐Ÿ‡ฎ๐Ÿ‡ณ The Vision: Digitising Governance at the Gram Panchayat Level +- Live Demo +- Screenshots +- Key Features +- Technologies Used +- Installation and Setup +- Acknowledgments +- Contact +- How to Contribute +- Contributing +- Code of Conduct +- Contribution Guidelines +- Suggestions & Feedback +- Show Your Support +- License +- Stargazers +- Forkers +- Project Admin + + + +

๐Ÿ” Overview

+ +> **SaralSeva** is a web-based full stack application designed to streamline the application and grievance resolution process for rural government schemes. This platform offers user-friendly features for users to apply for schemes, track their progress, and receive updates, as well as powerful tools for administrators and employees to manage scheme applications, monitor performance, and communicate effectively. + + -**SaralSeva** is a web-based full stack application designed to streamline the application and grievance resolution process for rural government schemes. This platform offers user-friendly features for users to apply for schemes, track their progress, and receive updates, as well as powerful tools for administrators and employees to manage scheme applications, monitor performance, and communicate effectively. - ---- +
+ Thanks Banner Typing SVG +
-## ๐Ÿ‡ฎ๐Ÿ‡ณ The Vision: Digitising Governance at the Gram Panchayat Level + + +

๐Ÿ“Š Project Insights

+ + + + + + + + + + + + + + + + + + + + + + + + +
๐ŸŒŸ Stars๐Ÿด Forks๐Ÿ› Issues๐Ÿ”” Open PRs๐Ÿ”• Closed PRs๐Ÿ› ๏ธ Languages๐Ÿ‘ฅ Contributors
StarsForksIssuesOpen PRsClosed PRsLanguages CountContributors Count
+ + + +

๐Ÿ‡ฎ๐Ÿ‡ณ The Vision: Digitising Governance at the Gram Panchayat Level

SaralSeva is more than just a software project; it's an initiative for social good, aimed at strengthening governance from the ground up. It directly contributes to building a more inclusive and transparent Digital India by focusing on: @@ -16,38 +78,33 @@ SaralSeva is more than just a software project; it's an initiative for social go * The platform serves as a central repository of information on all available government schemes. This empowers citizens with the information they need to claim their rights and improve their livelihoods. * With dedicated portals for employees and administrators, tasks are clearly assigned and tracked. The integrated grievance redressal system ensures that citizen concerns are heard and addressed in a structured manner. ---- -## ๐Ÿš€ Live Demo + + +

๐Ÿš€ Live Demo

-Experience SaralSeva live here: +Experience SaralSeva live here: ๐Ÿ‘‰ [![**SaralSeva**](https://img.shields.io/badge/View-Live%20Demo-orange?style=for-the-badge)](https://saralseva.vercel.app/) -
-

+ [![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/) ![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg?style=flat) +![Built with Love](https://img.shields.io/badge/Built%20with-%E2%9D%A4-red?style=for-the-badge) ![Visitors](https://api.visitorbadge.io/api/Visitors?path=eccentriccoder01%2FSaralSeva%20&countColor=%23263759&style=flat) -![GitHub Forks](https://img.shields.io/github/forks/eccentriccoder01/SaralSeva) -![GitHub Repo Stars](https://img.shields.io/github/stars/eccentriccoder01/SaralSeva) ![GitHub Contributors](https://img.shields.io/github/contributors/eccentriccoder01/SaralSeva) ![GitHub Last Commit](https://img.shields.io/github/last-commit/eccentriccoder01/SaralSeva) ![GitHub Repo Size](https://img.shields.io/github/repo-size/eccentriccoder01/SaralSeva) ![Github](https://img.shields.io/github/license/eccentriccoder01/SaralSeva) -![GitHub Issues](https://img.shields.io/github/issues/eccentriccoder01/SaralSeva) -![GitHub Closed Issues](https://img.shields.io/github/issues-closed-raw/eccentriccoder01/SaralSeva) -![GitHub Pull Requests](https://img.shields.io/github/issues-pr/eccentriccoder01/SaralSeva) -![GitHub Closed Pull Requests](https://img.shields.io/github/issues-pr-closed/eccentriccoder01/SaralSeva) -

-
-## ๐Ÿ“ธ Screenshots + + +

๐Ÿ“ธ Screenshots

---- + -## ๐ŸŒŸ Key Features +

๐ŸŒŸ Key Features

SaralSeva is built on a robust three-tier architecture, providing distinct, secure, and feature-rich portals for each user role. @@ -71,9 +128,28 @@ SaralSeva is built on a robust three-tier architecture, providing distinct, secu * **Final Approval Authority**: Power to give the final approval or rejection for all applications. * **Broadcast Announcements**: Create and display important updates for all citizens. ---- + + +![GSSoC Logo]( ) + +๐ŸŒŸ **Exciting News...** + +๐Ÿš€ This project is now an official part of GirlScript Summer of Code โ€“ GSSoC'25! ๐Ÿ’ƒ๐ŸŽ‰๐Ÿ’ป We're thrilled to welcome contributors from all over India and beyond to collaborate, build, and grow *SaralSeva!* Letโ€™s make learning and career development smarter โ€“ together! ๐ŸŒŸ๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ‘ฉโ€๐Ÿ’ป -## ๐Ÿ› ๏ธ Technology Stack +๐Ÿ‘ฉโ€๐Ÿ’ป GSSoC is one of Indiaโ€™s **largest 3-month-long open-source programs** that encourages developers of all levels to contribute to real-world projects ๐ŸŒ while learning, collaborating, and growing together. ๐ŸŒฑ + +๐ŸŒˆ With **mentorship, community support**, and **collaborative coding**, it's the perfect platform for developers to: + +- โœจ Improve their skills +- ๐Ÿค Contribute to impactful projects +- ๐Ÿ† Get recognized for their work +- ๐Ÿ“œ Receive certificates and swag! + +๐ŸŽ‰ **I canโ€™t wait to welcome new contributors** from GSSoC 2025 to this SaralSeva project family! Let's build, learn, and grow together โ€” one commit at a time. ๐Ÿ”ฅ๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ‘ฉโ€๐Ÿ’ป + + + +

๐Ÿ› ๏ธ Technologies Used

### Frontend @@ -94,9 +170,9 @@ SaralSeva is built on a robust three-tier architecture, providing distinct, secu ![Cloudinary](https://img.shields.io/badge/Cloudinary-3448C5?style=for-the-badge&logo=cloudinary&logoColor=white) ![Render](https://img.shields.io/badge/Render-0099FF?style=for-the-badge&logo=render&logoColor=white) ---- + -## โš™๏ธ Installation and Setup +

โš™๏ธ Installation and Setup

> The project is a monorepo containing four separate applications: `backend`, `user`, `employee`, and `admin`. Each must be set up and run independently. @@ -109,9 +185,9 @@ Ensure you have the following installed: ### 1. Clone the repository: ```bash -git clone [https://github.com/eccentriccoder01/SaralSeva.git](https://github.com/eccentriccoder01/SaralSeva.git) +git clone https://github.com/eccentriccoder01/SaralSeva.git cd SaralSeva -```` +``` ### 2\. Set up the Backend (`/backend`): @@ -128,18 +204,27 @@ PORT=8000 MONGODB_URL=YOUR_MONGODB_CONNECTION_STRING JWT_SECRET=YOUR_JWT_SECRET_KEY +``` -# Twilio Credentials (I haven't provided my Twilio credentials in the deployment, since it is paid, LOL) +Twilio Credentials (I haven't provided my Twilio credentials in the deployment, since it is paid, LOL) + +```bash TWILIO_ACCOUNT_SID=YOUR_TWILIO_SID TWILIO_AUTH_TOKEN=YOUR_TWILIO_AUTH_TOKEN TWILIO_PHONE_NUMBER=YOUR_TWILIO_PHONE_NUMBER +``` + + Cloudinary Credentials -# Cloudinary Credentials +```bash CLOUDINARY_NAME=YOUR_CLOUDINARY_CLOUD_NAME CLOUDINARY_API_KEY=YOUR_CLOUDINARY_API_KEY CLOUDINARY_SECRET_KEY=YOUR_CLOUDINARY_API_SECRET +``` + +Firebase Credentials -# Firebase Credentials +```bash FIREBASE_API_KEY=YOUR_FIREBASE_API_KEY FIREBASE_AUTH_DOMAIN=YOUR_FIREBASE_AUTH_DOMAIN FIREBASE_PROJECT_ID=YOUR_FIREBASE_PROJECT_ID @@ -174,29 +259,7 @@ npm install npm run dev ``` ------ - -### ๐Ÿค Contributors -We appreciate all the amazing people who have contributed to SaralSeva! ๐Ÿ™ -
- - Contributors - -
- -#### How to Become a Contributor -We welcome contributions from developers of all skill levels! Here are some ways you can contribute: - -- ๐Ÿ› Bug fixes - Help us identify and fix bugs -- โœจ New features - Suggest and implement new functionality -- ๐Ÿ“š Documentation - Improve our docs and guides -- ๐ŸŽจ UI/UX improvements - Make the platform more user-friendly -- ๐Ÿ”ง Performance optimizations - Help make SaralSeva faster and more efficient -- ๐ŸŒ Translations - Help make SaralSeva accessible in more languages -- ๐Ÿ“ฑ Mobile responsiveness - Improve the mobile experience -- ๐Ÿ”’ Security enhancements - Help keep user data safe - -Thank you to everyone who has made SaralSeva better! ๐Ÿ’š + ## Issue Creation โœด @@ -220,12 +283,176 @@ Whether it's a new feature, design improvement, or a bug fix - your voice matter Your insights are invaluable to us. Reach out to us team for any inquiries, feedback, or concerns. -## ๐Ÿ“„ License + + +

๐Ÿ™ Acknowledgments

+ +- Thanks to all contributors of this project +- Special shoutout to **GirlScript Summer of Code (GSSoCโ€™25)** for the amazing community and support! +- Built with dedication, collaboration, and lots of chai + + + +

๐Ÿ“ž Contact

+ +- **Developed by [Eccentric Explorer](https://eccentriccoder01.github.io/Me)** +- **GitHub Issues**: [Report bugs or request features](https://github.com/eccentriccoder01/SaralSeva/issues) +- **Email**: Contact the maintainers for collaboration opportunities + +*Feel free to reach out with any questions or feedback!* + + + +

๐ŸคHow to Contribute

+ +We love contributions from the community! Whether it's a bug report, a new feature, or a documentation improvement, we appreciate your help. + +***How to Contribute*** + +1. **Fork the repository** and create a new branch for your changes. +2. **Make your changes** and ensure everything is working as expected. +3. **Submit a pull request** with a clear description of your changes. + +***Found a Bug?*** + +- Check the [issue tracker](https://github.com/eccentriccoder01/SaralSeva/issues) to see if the bug has already been reported. +- If not, open a new issue and provide as much detail as possible. + +***Have a Feature Idea?*** + +- We'd love to hear it! Open an issue to discuss your idea. + + + +

๐Ÿค Contributing

+ +We welcome contributions from developers of all skill levels! Here are some ways you can contribute: + +### Ways to Contribute + +- ๐Ÿ› Bug fixes - Help us identify and fix bugs +- โœจ New features - Suggest and implement new functionality +- ๐Ÿ“š Documentation - Improve our docs and guides +- ๐ŸŽจ UI/UX improvements - Make the platform more user-friendly +- ๐Ÿ”ง Performance optimizations - Help make SaralSeva faster and more efficient +- ๐ŸŒ Translations - Help make SaralSeva accessible in more languages +- ๐Ÿ“ฑ Mobile responsiveness - Improve the mobile experience +- ๐Ÿ”’ Security enhancements - Help keep user data safe + +*Thank you to everyone who has made SaralSeva better! ๐Ÿ’š* + + + +

๐Ÿ“œ Code of Conduct

+ +Please refer to the [`Code of Conduct`](https://github.com/eccentriccoder01/SaralSeva/blob/main/CODE_OF_CONDUCT.md) for details on contributing guidelines and community standards. + + + +

๐Ÿค๐Ÿ‘ค Contribution Guidelines

+ +We love our contributors! If you'd like to help, please check out our [`CONTRIBUTE.md`](https://github.com/eccentriccoder01/SaralSeva/blob/main/CONTRIBUTING.md) file for guidelines. + +>Thank you once again to all our contributors who has contributed to **SaralSeva!** Your efforts are truly appreciated. ๐Ÿ’–๐Ÿ‘ + + + +[![Contributors](https://img.shields.io/github/contributors/eccentriccoder01/SaralSeva?style=for-the-badge)](https://github.com/RhythmPahwa14/eccentriccoder01/SaralSeva/contributors) + + +

+ + Contributors + +

+ +See the full list of contributors and their contributions on the [`GitHub Contributors Graph`](https://github.com/eccentriccoder01/SaralSeva/graphs/contributors). + + + +

+

Show some Red Heart by starring this awesome repository! +

+

+ + -This project is open-source and available under the MIT License. +

๐Ÿ’ก Suggestions & Feedback

-## ๐Ÿ“ž Contact +Feel free to open issues or discussions if you have any feedback, feature suggestions, or want to collaborate! + + + +

๐Ÿ™Œ Show Your Support

+ +*If you find SaralSeva project helpful, give it a star! โญ to support more such educational initiatives:* + +- โญ **Starring the repository** +- ๐Ÿฆ **Sharing on social media** +- ๐Ÿ’ฌ **Telling your friends and colleagues** +- ๐Ÿค **Contributing to the project** + + + +

๐Ÿ“„ License

+ +This project is licensed under the MIT License - see the [`License`](https://github.com/eccentriccoder01/SaralSeva/blob/main/LICENSE) file for details. + + + +

โญ Stargazers

+ +
+ + Stargazers + +
+ + + +

๐Ÿด Forkers

+ +
+ + Forkers + +
+ + + +

๐Ÿง‘โ€๐Ÿ’ปProject Admin:

+ + + + +
+Sagnik Chakraborty
Sagnik Chakraborty
+
+
+ + + +

Glowing Star Give us a Star and let's make magic! Glowing Star

+ +

+ Mirror Ball +

+ + + +

๐Ÿ‘จโ€๐Ÿ’ป Built with โค๏ธ by SaralSeva Team

+

โค๏ธ Sagnik Chakraborty and Contributors โค๏ธ

+

+ Open an Issue | ๐ŸŒŸ Star on GitHub | ๐Ÿš€ Live Demo

+ + + +

+ + โฌ†๏ธ Back to Top + +

-Developed by [Eccentric Explorer](https://eccentriccoder01.github.io/Me) + -Feel free to reach out with any questions or feedback\! +> Ready to show off your coding achievements? Get started with **SaralSeva** today! ๐Ÿš€ \ No newline at end of file diff --git a/gssoc logo.png b/gssoc logo.png new file mode 100644 index 0000000..c01f851 Binary files /dev/null and b/gssoc logo.png differ