Skip to content

MessWala Documentation

Welcome to the MessWala documentation portal. This is the central hub for all information about the MessWala application — a comprehensive mess management system for transparent, data-driven hostel mess operations.

Last Updated: March 17, 2026 | Status: ✅ Production Ready

📚 Documentation Structure

🚀 Getting Started

Quick onboarding guide for new users. Learn how to: - Create an account - Login (Google or Email/Password) - Complete your profile - Access your dashboard

👥 User Roles & Permissions

Understanding the three main user roles: - Admin — Mess configuration & user management - Manager — Expenses, menu, analytics - Student — Attendance, feedback, menu view

✨ Features Guide

In-depth guides for each feature: - Expense tracking & analytics - Meal attendance system - Menu management - Feedback & ratings - Dashboard & analytics

🏗️ System Architecture

Technical deep-dive: - System architecture & components - Database schema & models - Configuration system - Data flow & relationships

📡 API Reference

Complete API documentation: - Authentication endpoints - Expense, meal, attendance APIs - Analytics endpoints - User management - Admin setup endpoints

🚢 Deployment Guide

Step-by-step deployment instructions: - Frontend deployment (Vercel) - Backend deployment (Render) - Database setup (MongoDB) - Environment configuration

⚙️ Admin Guide

Admin-specific documentation: - First-time mess configuration - User approval workflow - Category & meal time management - System settings

🔧 Troubleshooting

Common issues and solutions: - Login problems - Data not displaying - Configuration issues - API errors

Use Case Link
First time setup? Deployment Guide
Need to configure mess? Admin Setup Wizard
Want to integrate API? API Reference
Understanding the system? System Architecture
Forgot how to use a feature? Features Guide
Setting up user roles? User Management

📱 System Information

Current Version: 2.0 (Dynamic SaaS Release)

Key Technologies: - Frontend: React + Vite + Tailwind CSS - Backend: Node.js + Express - Database: MongoDB - Hosting: Vercel (Frontend) + Render (Backend) - Authentication: JWT + Google OAuth

Supported Browsers: - Chrome/Edge 90+ - Firefox 88+ - Safari 14+ - Mobile browsers (iOS Safari, Chrome Mobile)

🔐 Security

MessWala follows industry best practices:

  • ✅ HTTPS-only communication
  • ✅ JWT token-based authentication
  • ✅ HTTP-only secure cookies
  • ✅ Password hashing (bcrypt)
  • ✅ Rate limiting
  • ✅ CORS protection
  • ✅ MongoDB Atlas encryption
  • ✅ Regular security audits

🤝 Support & Community

Need help? - Check Troubleshooting Guide - Review FAQs - Contact your mess admin

Found a bug? - Report on GitHub Issues - Include steps to reproduce - Attach screenshots if applicable

Want to contribute? - See CONTRIBUTING.md in the repository - Fork the repo and submit PRs - Follow code style guidelines

📖 Documentation Management

This documentation is: - Version controlled — Tracked in Git - Searchable — Full-text search enabled - Responsive — Works on desktop and mobile - Offline-capable — Can be downloaded as PDF - Continuously updated — Latest version always available

🚀 Getting Started Path

graph LR
    A[New to MessWala?] --> B[Read Getting Started]
    B --> C{What's your role?}
    C -->|Admin| D[Admin Setup Wizard]
    C -->|Manager| E[Features Guide]
    C -->|Student| F[User Guide]
    D --> G[Ready to Deploy]
    E --> H[Ready to Use]
    F --> I[Ready to Use]
    G --> J{Need Help?}
    H --> J
    I --> J
    J -->|Yes| K[Troubleshooting Guide]
    J -->|No| L[Start Using MessWala!]
    K --> L

📞 Contact & Support

Topic Contact
Technical Issues GitHub Issues
Feature Requests GitHub Discussions
Security Issues Report privately via GitHub Security Advisory
Admin Support Contact your mess administrator

Last Updated: March 17, 2026
Version: 2.0 (Dynamic SaaS Release)
Status: ✅ Production Ready