Smart Canteen Platform (CMS)

An open-source, full-stack web platform built to streamline and digitize canteen operations from real-time inventory tracking and order handling to a responsive, role-based staff dashboard.

Designed with scalability and user experience in mind, CMS is powered by React, Supabase, and Tailwind CSS — making it a strong fit for both institutional use and production-ready deployment.

⚡ Built for performance. Designed for people. Powered by open source.

🛠️ Installation

Option 1: Docker Setup (Recommended)

Prerequisites

• Docker and Docker Compose installed
• Docker daemon running

Instant Setup

# Clone the repository
git clone https://github.com/Nishal77/SCS.git
cd SCS

# Gives permission to execute the setup file
chmod +x setup.sh

# Runs the setup script for instant deployment
./setup.sh

The application will be available at http://localhost:3000

Option 2: Manual Setup

1. Clone the Repository

git clone https://github.com/Nishal77/SCS.git
cd SCS

2. Install Dependencies

npm install

3. Environment Setup

# Copy the example environment file
cp env.example .env

# Edit the .env file with your Supabase credentials
nano .env

4. Configure Environment Variables

Add your Supabase credentials to the .env file:

VITE_SUPABASE_URL=your_supabase_project_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

5. Start the Development Server

npm run dev

The application will be available at http://localhost:5173

⚙️ Usage

1. Access the application in your browser:

# Docker deployment
http://localhost:3000

# Manual deployment
http://localhost:5173

2. Login using the provided credentials (for staff access):

• Email: staff@canteen.com
• Password: staff123

🔌 API Endpoints

Authentication

// User Sign Up
const { data, error } = await supabase.auth.signUp({
  email: 'user@example.com',
  password: 'password123'
})

// User Sign In
const { data, error } = await supabase.auth.signInWithPassword({
  email: 'user@example.com',
  password: 'password123'
})

// User Sign Out
const { error } = await supabase.auth.signOut()

Inventory Management

// Get All Products
const { data, error } = await supabase
  .from('inventory')
  .select('*')
  .order('created_at', { ascending: false })

// Add New Product
const { data, error } = await supabase
  .from('inventory')
  .insert({
    item_name: 'Product Name',
    price: 100.00,
    category: 'Breakfast',
    food_type: 'veg',
    stock_constant: 50,
    stock_available: 50,
    is_todays_special: false
  })

// Update Product
const { data, error } = await supabase
  .from('inventory')
  .update({ price: 150.00 })
  .eq('id', 'product_id')

// Delete Product
const { error } = await supabase
  .from('inventory')
  .delete()
  .eq('id', 'product_id')

// Filter Products
const { data, error } = await supabase
  .from('inventory')
  .select('*')
  .eq('food_type', 'veg') // or 'category', 'Breakfast'

File Storage

// Upload Image
const { data, error } = await supabase.storage
  .from('product-images')
  .upload('filename.jpg', file)

// Get Image URL
const { data } = supabase.storage
  .from('product-images')
  .getPublicUrl('filename.jpg')

🔧 Development

Docker Commands

# Production build and run
docker-compose up -d

# Development mode with hot reload
docker-compose --profile dev up -d

# View logs
docker-compose logs -f

# Stop application
docker-compose down

# Rebuild and restart
docker-compose up -d --build

Available Scripts

npm run dev          # Start development server
npm run build        # Build for production
npm run preview      # Preview production build
npm run lint         # Run ESLint

🤝 Contributing

We welcome contributions from the community! There are many ways to support and improve the Smart Canteen Management System (CMS) and writing code is just one of them. Whether it’s fixing bugs, improving documentation, designing UI/UX, suggesting new features, or sharing feedback every contribution counts.

If you’d like to contribute code, follow these simple steps:

1. Fork the repository. Fork the repository.

2. Clone the fork to your local machine:

   git clone https://github.com/<your username>/SCS.git
   cd SCS

3. Create a new branch

   git checkout -b feature/your-feature-name

4. Make your changes and commit them

   git commit -am 'feat: Add some feature'

5. Push to the branch

   git push origin feature/your-feature-name

6. Go to the repository and make a Pull Request.