Skip to content

A SaaS platform tailored for local restaurants, providing inventory management, menu optimization, customer feedback analysis, and online ordering integration.

License

Notifications You must be signed in to change notification settings

mobeen-asghar/RestroBoost

Repository files navigation

🍽️ RestroBoost - Restaurant Management SaaS Platform

React TypeScript Tailwind CSS Vite License

RestroBoost is a comprehensive restaurant management platform that helps local restaurants increase revenue, reduce waste, and delight customers through smart technology and data-driven insights.

✨ Features

πŸ“Š Smart Analytics Dashboard

  • Real-time revenue tracking and forecasting
  • Customer behavior analysis and insights
  • Peak hours identification and optimization
  • Comprehensive reporting tools
  • Performance metrics visualization

πŸ“¦ Intelligent Inventory Management

  • Real-time stock monitoring with automated alerts
  • Smart reorder notifications based on usage patterns
  • Supplier management and cost tracking
  • Waste reduction insights and recommendations
  • Critical/low/good stock status indicators

πŸ• Menu Optimization

  • AI-powered menu performance analysis
  • Profit margin calculations and optimization
  • Sales trend tracking and forecasting
  • Customer preference insights
  • Dynamic pricing recommendations

πŸ’¬ Customer Feedback Intelligence

  • Sentiment analysis with AI-powered insights
  • Multi-platform review aggregation
  • Response management tools
  • Customer satisfaction scoring
  • Actionable improvement suggestions

πŸ›’ Seamless Online Ordering

  • Multi-platform order management (DoorDash, Uber Eats, etc.)
  • Real-time order tracking and status updates
  • Kitchen display integration
  • Customer communication tools
  • Delivery optimization

πŸ‘₯ User Management & Authentication

  • Secure user authentication system
  • Role-based access control
  • Profile management
  • Multi-restaurant support
  • Settings customization

πŸš€ Live Demo

Demo Credentials:

  • Email: Create free account
  • Password: Any password works for demo

πŸ”— Try RestroBoost Live

πŸ› οΈ Tech Stack

  • Frontend: React 18.3.1 with TypeScript
  • Styling: Tailwind CSS 3.4.1
  • Build Tool: Vite 5.4.2
  • Icons: Lucide React
  • State Management: React Hooks + localStorage
  • Routing: Client-side routing
  • Deployment: Netlify/Vercel ready

πŸ“‹ Prerequisites

Before running this project, make sure you have:

  • Node.js (v18 or higher)
  • npm or yarn package manager
  • Modern web browser (Chrome, Firefox, Safari, Edge)

⚑ Quick Start

1. Clone the Repository

git clone https://github.com/mobeen-asghar/RestroBoost.git
cd RestroBoost

2. Install Dependencies

npm install
# or
yarn install

3. Start Development Server

npm run dev
# or
yarn dev

4. Open in Browser

Navigate to http://localhost:5173 in your browser.

πŸ“ Project Structure

restroboost/
β”œβ”€β”€ public/                 # Static assets
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/         # React components
β”‚   β”‚   β”œβ”€β”€ auth/          # Authentication components
β”‚   β”‚   β”œβ”€β”€ modals/        # Modal components
β”‚   β”‚   └── public/        # Public pages
β”‚   β”œβ”€β”€ types/             # TypeScript type definitions
β”‚   β”œβ”€β”€ utils/             # Utility functions
β”‚   β”‚   β”œβ”€β”€ auth.ts        # Authentication utilities
β”‚   β”‚   └── storage.ts     # localStorage management
β”‚   β”œβ”€β”€ App.tsx            # Main application component
β”‚   β”œβ”€β”€ main.tsx           # Application entry point
β”‚   └── index.css          # Global styles
β”œβ”€β”€ package.json           # Dependencies and scripts
β”œβ”€β”€ tailwind.config.js     # Tailwind CSS configuration
β”œβ”€β”€ tsconfig.json          # TypeScript configuration
└── vite.config.ts         # Vite configuration

🎯 Key Components

Dashboard Components

  • Dashboard.tsx - Main analytics dashboard
  • Inventory.tsx - Inventory management interface
  • MenuOptimization.tsx - Menu performance analysis
  • CustomerFeedback.tsx - Feedback management system
  • OnlineOrdering.tsx - Order management interface

Authentication System

  • Login.tsx - User login interface
  • Signup.tsx - User registration
  • Settings.tsx - User profile management
  • ProtectedRoute.tsx - Route protection

Modal Components

  • AddInventoryModal.tsx - Add new inventory items
  • EditInventoryModal.tsx - Edit existing inventory
  • AddMenuItemModal.tsx - Create menu items
  • EditMenuItemModal.tsx - Edit menu items
  • AddOrderModal.tsx - Create new orders
  • AddFeedbackModal.tsx - Add customer feedback

Public Pages

  • LandingPage.tsx - Marketing homepage
  • FeaturesPage.tsx - Feature showcase
  • PricingPage.tsx - Pricing plans
  • CaseStudiesPage.tsx - Success stories
  • AboutPage.tsx - Company information

πŸ’Ύ Data Management

RestroBoost uses localStorage for data persistence, making it perfect for demos and prototypes. The data structure includes:

  • Users - Authentication and profile data
  • Inventory - Stock items with status tracking
  • Menu Items - Restaurant menu with performance metrics
  • Orders - Customer orders with status management
  • Feedback - Customer reviews and ratings

Sample Data

The application automatically generates realistic sample data including:

  • 10+ inventory items with various stock levels
  • 8+ menu items with sales data and ratings
  • Multiple customer orders with different statuses
  • Customer feedback with sentiment analysis

🎨 Design System

Color Palette

  • Primary: Yellow (#EAB308) - Brand color for CTAs and highlights
  • Secondary: Gray (#6B7280) - Text and subtle elements
  • Success: Green (#10B981) - Positive actions and status
  • Warning: Yellow (#F59E0B) - Alerts and warnings
  • Error: Red (#EF4444) - Errors and critical status

Typography

  • Headings: Inter font family, bold weights
  • Body: Inter font family, regular weight
  • Code: Monospace font family

Components

  • Consistent 8px spacing system
  • Rounded corners (4px, 8px, 12px)
  • Subtle shadows and hover effects
  • Responsive design with mobile-first approach

πŸ”§ Available Scripts

# Development
npm run dev          # Start development server
npm run build        # Build for production
npm run preview      # Preview production build

# Code Quality
npm run lint         # Run ESLint
npm run type-check   # Run TypeScript compiler

πŸ“± Responsive Design

RestroBoost is fully responsive and optimized for:

  • Desktop (1024px+) - Full dashboard experience
  • Tablet (768px-1023px) - Adapted layouts
  • Mobile (320px-767px) - Mobile-optimized interface

πŸ” Authentication

The demo authentication system includes:

  • Demo Account: demo@restroboost.com (any password)
  • Registration: Create new accounts
  • Profile Management: Update user information
  • Session Management: Persistent login state

πŸš€ Deployment

Netlify Deployment

  1. Build the project: npm run build
  2. Deploy the dist folder to Netlify
  3. Configure redirects for SPA routing

Vercel Deployment

  1. Connect your GitHub repository
  2. Vercel will automatically detect Vite configuration
  3. Deploy with zero configuration

Manual Deployment

npm run build
# Upload the dist/ folder to your hosting provider

🀝 Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Development Guidelines

  • Follow TypeScript best practices
  • Use Tailwind CSS for styling
  • Maintain component modularity
  • Write descriptive commit messages
  • Test thoroughly before submitting

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

  • React Team - For the amazing React framework
  • Tailwind CSS - For the utility-first CSS framework
  • Lucide - For the beautiful icon library
  • Vite - For the lightning-fast build tool
  • Pexels - For the high-quality stock photos

πŸ“ž Support

πŸ—ΊοΈ Roadmap

Phase 1 (Current)

  • βœ… Core dashboard functionality
  • βœ… Inventory management
  • βœ… Menu optimization
  • βœ… Customer feedback system
  • βœ… Order management

Phase 2 (Planned)

  • πŸ”„ Real-time notifications
  • πŸ”„ Advanced analytics
  • πŸ”„ Multi-location support
  • πŸ”„ API integrations
  • πŸ”„ Mobile app

Phase 3 (Future)

  • πŸ“‹ AI-powered recommendations
  • πŸ“‹ Advanced reporting
  • πŸ“‹ Third-party integrations
  • πŸ“‹ White-label solutions

Built with ❀️ for the restaurant industry

⭐ Star this repo β€’ πŸ› Report Bug β€’ πŸ’‘ Request Feature

About

A SaaS platform tailored for local restaurants, providing inventory management, menu optimization, customer feedback analysis, and online ordering integration.

Topics

Resources

License

Stars

Watchers

Forks

Languages