From 2c17e37ebca914e5b7c45da7649ffc36e492200d Mon Sep 17 00:00:00 2001 From: Gaurav Kumar <166138317+GauravK1704@users.noreply.github.com> Date: Mon, 17 Nov 2025 20:29:07 +0530 Subject: [PATCH] Revise README formatting and content Updated README.md to enhance formatting and content clarity. --- README.md | 575 +++++++++++++----------------------------------------- 1 file changed, 134 insertions(+), 441 deletions(-) diff --git a/README.md b/README.md index a9bb338..bb7564f 100644 --- a/README.md +++ b/README.md @@ -1,513 +1,206 @@ + -
SaralSeva Logo
- -

SARALSEVA

- -
- ๐Ÿ› Report Bug - โ€ข +
+ SaralSeva Logo +

SARALSEVA

+ ๐Ÿ› Report Bug โ€ข ๐Ÿ’ก Request Feature -
- - -

๐Ÿ” 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. - - +# ๐Ÿ” Overview +> **SaralSeva** is a full-stack web application that simplifies applying for government schemes and resolving grievances at the Gram Panchayat level.
- Thanks Banner Typing SVG +
- - -

๐Ÿ“Š 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 strengthens grassroots governance to build a more inclusive and transparent Digital India: - -- ๐ŸŒ 24/7 digital access to services โ€” fewer in-person visits -- ๐Ÿ”Ž Endโ€‘toโ€‘end tracking with unique IDs for trust and accountability -- โš™๏ธ Automated workflows to reduce delays and speed up delivery -- ๐Ÿ“š Centralised scheme information that empowers citizens -- ๐Ÿ‘ฅ Clear roles for staff and structured grievance redressal - - - -

๐Ÿค” Why SaralSeva?

- -SaralSeva is built to make governance accessible, transparent, and efficient for everyone: - -- ๐Ÿงญ One-stop platform: apply for schemes, file grievances, and track updates in one place -- ๐Ÿ” Full transparency: real-time status, clear next steps, and notifications at each stage -- โš™๏ธ Streamlined processing: automated workflows reduce manual delays and errors -- ๐Ÿ›ก๏ธ Secure by design: role-based access, auditable actions, and safe data handling -- ๐Ÿ“ฑ Citizen-first experience: simple forms, PDF receipts, and multilingual-ready UI - - - -

๐ŸŽฏ Mission

+--- -Our mission is to make essential public services simple, transparent, and accessible for every citizen: +# ๐Ÿ“Š Project Insights -- ๐Ÿšช Accessibility first: 24/7 digital access to schemes and grievance services -- ๐Ÿ”Ž Transparency by design: end-to-end tracking and clear status at each stage -- โš™๏ธ Efficiency at scale: automated, auditable workflows that reduce delays -- ๐Ÿค Citizen empowerment: clear guidance, easy applications, and timely updates -- ๐Ÿ›ก๏ธ Reliability: secure data handling and role-based access for admins/employees - -

๐Ÿš€ Live Demo

- -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 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) +
- + + + + + + + + + + + + + + + + + + + + + + + +
StarsForksIssuesOpen PRsClosed PRsLanguagesContributors
-

๐Ÿ“ธ Screenshots

+
-
+--- - +# ๐Ÿ‡ฎ๐Ÿ‡ณ Vision โ€“ Digitising Rural Governance +- 24/7 digital access to services +- End-to-end tracking +- Automated workflows +- Citizen empowerment +- Centralised scheme information -

๐ŸŒŸ Key Features

+--- -SaralSeva is built on a robust three-tier architecture, providing distinct, secure, and feature-rich portals for each user role. +# ๐Ÿค” Why SaralSeva? +- One-stop portal +- Real-time notifications +- Secure authentication +- PDF receipts +- Mobile & multilingual -### ๐Ÿ‘ค **Citizen Portal** +--- -- ๐Ÿ” **User Registration & Authentication**: Secure registration and login system with JWT and OTP verification via Twilio. -- ๐Ÿ“ **Scheme & Grievance Applications**: Users can easily apply for government schemes and submit grievances through intuitive forms. -- โฑ๏ธ **Real-time Status Tracking**: Users can track the progress of their applications and grievances with a unique ID. -- ๐Ÿ“Š **Personalised Dashboard**: A central place for users to view their application history and manage their profile. -- ๐Ÿ“„ **PDF Downloads**: Users can download their applications as PDFs via `jsPDF` for their records. +# ๐ŸŽฏ Mission +- Transparent +- Accessible +- Automated +- User-first -### ๐Ÿง‘โ€๐Ÿ’ผ **Employee Portal** +--- -- ๐Ÿ“‹ **Task-Oriented Dashboard**: A clear view of all assigned scheme applications (tickets) and grievances. -- ๐Ÿ› ๏ธ **Application Processing**: Tools to review applications, verify documents, and update statuses. -- ๐Ÿ“ˆ **Performance Insights**: Admins can track and visualise employee performance data. -- ๐Ÿ”’๐Ÿ’ฌ **Secure Messaging**: Internal chat system for communication with the admin. +# ๐Ÿš€ Live Demo +[![Live Demo](https://img.shields.io/badge/View-Live%20Demo-orange?style=for-the-badge)](https://saralseva.vercel.app/) -### ๐Ÿ›ก๏ธ **Admin Portal** +--- -- ๐Ÿ“Š **Comprehensive Dashboard**: A high-level overview of all platform activity, including application statistics and employee performance. -- ๐Ÿ—‚๏ธ **Scheme Management**: Full control to add, update, and manage all available government schemes. -- ๐Ÿค– **Automated Ticket Assignment**: Fair distribution of applications among employees. -- โœ… **Final Approval Authority**: Power to give the final approval or rejection for all applications. -- ๐Ÿ“ข **Broadcast Announcements**: Create and display important updates for all citizens. +# ๐Ÿ† Badges +![Open Source](https://badges.frapsoft.com/os/v1/open-source.svg?v=103) +![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen) +![Built with Love](https://img.shields.io/badge/Built%20with-%E2%9D%A4-red) +![Visitors](https://api.visitorbadge.io/api/Visitors?path=eccentriccoder01%2FSaralSeva) +![Contributors](https://img.shields.io/github/contributors/eccentriccoder01/SaralSeva) +![Last Commit](https://img.shields.io/github/last-commit/eccentriccoder01/SaralSeva) +![Repo Size](https://img.shields.io/github/repo-size/eccentriccoder01/SaralSeva) +![License](https://img.shields.io/github/license/eccentriccoder01/SaralSeva) - +--- -

๐Ÿ› ๏ธ Technologies Used

+# ๐Ÿ“ธ Screenshots +
+ +
-### Frontend +--- -![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB) -![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white) -![ShadCN](https://img.shields.io/badge/ShadCN-FED7D7?style=for-the-badge) -![Vite](https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white) -![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white) +# ๐ŸŒŸ Key Features -### Backend +## Citizen Portal +- OTP login +- Scheme + Grievance application +- PDF downloads +- Tracking dashboard -![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=node.js&logoColor=white) -![Express.js](https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white) -![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white) -![JWT](https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=JSON%20web%20tokens&logoColor=white) -![bcrypt](https://img.shields.io/badge/bcrypt-00C7B7?style=for-the-badge) -![Twilio](https://img.shields.io/badge/Twilio-F22F46?style=for-the-badge&logo=twilio&logoColor=white) -![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) +## Employee Portal +- Application review +- Verification tools +- Performance analytics -### DevOps & Automation +## Admin Portal +- Analytics dashboard +- Scheme management +- Employee assignment -![Dependabot](https://img.shields.io/badge/Dependabot-025E8C?style=for-the-badge&logo=dependabot&logoColor=white) -![GitHub Actions](https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=github-actions&logoColor=white) +--- - +# ๐Ÿ›  Technologies -

๐Ÿค– Automated Dependency Management

+### Frontend +React ยท ShadCN ยท Tailwind ยท Vite ยท Vercel -SaralSeva uses **GitHub Dependabot** for automated dependency updates and security vulnerability management: +### Backend +Node.js ยท Express.js ยท MongoDB ยท JWT ยท Cloudinary ยท Twilio -- ๐Ÿ”’ **Automatic security updates** - Immediate PRs for vulnerabilities -- ๐Ÿ“… **Weekly dependency updates** - Scheduled maintenance every Monday -- ๐ŸŽฏ **Smart grouping** - Related updates bundled together to reduce PR noise -- ๐Ÿท๏ธ **Auto-labeling** - Organized by module and update type -- โšก **Zero maintenance** - Works automatically in the background +### DevOps +GitHub Actions ยท Dependabot -[๐Ÿ“– Learn more about our Dependabot setup](./DEPENDABOT.md) +--- - +# ๐Ÿค– Dependabot Automation +- Auto security updates +- Weekly dependencies +- Smart grouping +- Auto labeling -

๐Ÿงญ Project Flowchart

+--- -
+# ๐Ÿงญ Flowchart ```mermaid flowchart TD - A[Citizen] --> B[Apply for Scheme / File Grievance] + A[Citizen] --> B[Apply / File Grievance] B --> C[Employee Review] C -->|Verified| D[Admin Decision] C -->|More Info Needed| B - D -->|Approved| E[Notification to Citizen] - D -->|Rejected| E - E --> F[Track Status / Download PDF] -``` - -
- -

โš™๏ธ Installation and Setup

-

๐Ÿ“‹ Prerequisites

- -Ensure you have the following installed/configured: - -- ๐ŸŸข Node.js 18+ and npm -- ๐Ÿƒ MongoDB (local or Atlas) -- ๐Ÿ” Environment variables for JWT, MongoDB URL -- ๐Ÿ“ง Optional: Twilio (OTP), Cloudinary (media), Google OAuth Client ID + D -->|Approved/Rejected| E[Notify Citizen] + E --> F[Track Status / PDF] - -> The project is a monorepo containing four separate applications: `backend`, `user`, `employee`, and `admin`. Each must be set up and run independently. - -### Prerequisites - -Ensure you have the following installed: - -- **Node.js** and **npm** -- **MongoDB** (local or a cloud instance like MongoDB Atlas) - -### 1. Clone the repository: - -```bash +โš™๏ธ Installation & Setup +Clone Project git clone https://github.com/eccentriccoder01/SaralSeva.git cd SaralSeva -``` -### 2\. Set up the Backend (`/backend`): +Backend -a. Navigate to the backend directory: - -```bash cd backend -``` - -b. Create a `.env` file and add the following environment variables with your credentials: - -```env -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) - -```bash -TWILIO_ACCOUNT_SID=YOUR_TWILIO_SID -TWILIO_AUTH_TOKEN=YOUR_TWILIO_AUTH_TOKEN -TWILIO_PHONE_NUMBER=YOUR_TWILIO_PHONE_NUMBER -``` - -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 - -```bash -FIREBASE_API_KEY=YOUR_FIREBASE_API_KEY -FIREBASE_AUTH_DOMAIN=YOUR_FIREBASE_AUTH_DOMAIN -FIREBASE_PROJECT_ID=YOUR_FIREBASE_PROJECT_ID -FIREBASE_STORAGE_BUCKET=YOUR_FIREBASE_STORAGE_BUCKET -FIREBASE_MESSAGING_SENDER_ID=YOUR_FIREBASE_MESSAGING_SENDER_ID -FIREBASE_APP_ID=YOUR_FIREBASE_APP_ID -FIREBASE_MEASUREMENT_ID=YOUR_FIREBASE_MEASUREMENT_ID -``` - -Google Cloud Console (Google OAuth Client ID) - -1. Application type: Web Application -2. Authorized JavaScript origins: - - http://localhost:5173 (local development) - - Any other frontend URI you use -3. Redirect URIs: Not needed for this setup - -```bash -GOOGLE_CLIENT_ID=YOUR_GOOGLE_OAuth_CLIENT_ID -``` - -c. Install dependencies and run the server: - -```bash npm install npm start -``` - -### 3\. Set up the Frontends (`/user`, `/employee`, `/admin`): -> **Note:** The following `.env` configuration is **only for the `/user`**: - -```bash -VITE_API_BASE_URL=http://localhost:8000 # URL of your backend -VITE_GOOGLE_CLIENT_ID=YOUR_GOOGLE_OAuth_CLIENT_ID # Must match backend -``` - -> Repeat the following steps for each frontend directory (`user`, `employee`, and `admin`) in a **separate terminal**. - -a. Navigate to a frontend directory: - -```bash -# In a new terminal -cd user -``` - -b. Install dependencies and run the development server: - -```bash +Frontends +cd user / employee / admin npm install npm run dev -``` - - -

๐Ÿ› ๏ธ Troubleshooting

-- โ›” Node version errors: check `node -v` (need v18+) -- ๐Ÿ” Missing/incorrect .env: ensure `MONGODB_URL`, `JWT_SECRET`, optional third-party keys -- ๐Ÿ—„๏ธ MongoDB connection failed: allow IP in Atlas; verify user roles and connection string -- ๐Ÿ”Œ Port in use: change ports or kill process using `netstat -ano | findstr :8000` -- ๐ŸŒ CORS errors: verify frontend origin is allowed in server CORS config +๐Ÿ› ๏ธ Troubleshooting - +Node version mismatch -## Issue Creation โœด +Missing .env variables -Report bugs and issues or propose improvements through our GitHub repository's "Issues" tab. +MongoDB IP access issue -## Contribution Guidelines ๐Ÿ“‘ +CORS errors -- Firstly Star(โญ) the Repository -- Fork the Repository and create a new branch for any updates/changes/issue you are working on. -- Start Coding and do changes. -- Commit your changes -- Create a Pull Request which will be reviewed and suggestions would be added to improve it. -- Add Screenshots and updated website links to help us understand what changes is all about. - -- Check the [CONTRIBUTING.md](CONTRIBUTING.md) for detailed steps... - - - -## Contributing is fun๐Ÿงก - -We welcome all contributions and suggestions! -Whether it's a new feature, design improvement, or a bug fix - your voice matters ๐Ÿ’œ - -Your insights are invaluable to us. Reach out to us team for any inquiries, feedback, or concerns. - - - -

๐Ÿ™ 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! -

-

- - - -

๐Ÿ’ก Suggestions & Feedback

- -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 - -
+๐Ÿค Contributing - +Fork -

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

+Create branch -

- Mirror Ball -

+Commit - +PR -

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

-

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

+Follow guidelines - +๐Ÿ™ Acknowledgments -

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

- +Contributors -> Ready to show off your coding achievements? Get started with **SaralSeva** today! ๐Ÿš€ +GSSoCโ€™25 community - +โญ Stargazers +
+๐Ÿด Forkers +
+โœจ Built with โค๏ธ by Team SaralSeva +

โฌ†๏ธ Back to Top

```