Skip to content

Lord-Morpheus/MessManagementApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mess Buddy

Mess Buddy is an innovative dual-platform solution designed to streamline and optimize the management of mess facilities. The project consists of a web application for administrators and a mobile application for end-users, providing a comprehensive and user-friendly experience for all stakeholders.

Features

  • Web Application for Administrators:

    • Efficiently manage all aspects of mess facilities, including menu planning, inventory, and user management.
    • Utilize a clean and intuitive interface to streamline operations and improve decision-making.
  • Mobile Application for End-Users:

    • Simplify access to mess facilities with an easy-to-use mobile application.
    • Enable users to view menus, make selections, and provide feedback directly from their smartphones.
    • Achieved a 100% solution to the mess selection process, ensuring a seamless experience for all users.

Tools & Technologies

  • Frontend:

    • ReactJS - For building the web application's user interface.
    • Tailwind CSS - For designing responsive and modern UI components.
  • Backend:

    • Node.js - For building the server-side logic.
    • Express.js - As the web framework for handling HTTP requests and routing.
  • Mobile Development:

    • Flutter - For building the cross-platform mobile application.
  • Cloud Services:

    • Cloudinary - For managing and delivering images and media files.
    • AWS S3 Client - For secure storage and retrieval of data.

Folder Structure

  • Admin/: This directory contains the ReactJS web application tailored for administrators.
  • Backend/: This directory holds the server-side logic implemented with Node.js and Express.js.
  • Frontend/: This directory contains the Flutter mobile application for end-users.

Installation & Setup

  1. Clone the repository:

    git clone https://github.com/Lord-Morpheus/MessManagementApp.git
    cd MessManagementApp
  2. Install dependencies for the admin web application:

    cd Admin
    npm install
  3. Install dependencies for the backend:

    cd ../Backend
    npm install
  4. Install dependencies for the frontend mobile application:

    cd ../Frontend
    flutter pub get
  5. Set up environment variables:

    • Create a .env file in the root of both the admin, backend, and frontend directories.
    • Add your configuration details for Cloudinary, AWS S3, and other necessary services.
  6. Run the web application (Admin):

    cd ../Admin
    npm run dev
  7. Run the backend server:

    cd ../Backend
    npm run dev
  8. Run the mobile application (User-End):

    cd ../Frontend
    flutter run

Contributing

Contributions are welcome! Please follow the standard GitHub workflow:

  • Fork the repository.
  • Create a new branch for your feature or bug fix.
  • Commit your changes.
  • Push to your forked repository.
  • Submit a pull request.

Contact

For any inquiries or feedback, feel free to reach out:

LinkedIn: