MetroMart

Metromart is an enterprise-grade supermarket management solution designed to streamline fast, reliable, and scalable handling of all major retail processes. This project emphasizes robust database architecture to ensure integrity, normalization, and efficient data operations for large-scale supermarket chains and hypermarkets.​

Project Overview

MetroMart aims to provide features such as:

• Secure user authentication and profile management
• Comprehensive entity-relationship (ER) modeling for full retail workflows
• Multi-entity design for products, inventory, customers, suppliers, staff, sales, returns, and procurement
• Efficient query and transaction support for thousands of daily operations
• Data integrity and referential integrity through enforced foreign keys
• User-friendly shopping cart and seamless checkout process
• Comprehensive product catalog with categories and detailed information
• Efficient inventory management system

Tech Stack

• Runtime: Node.js (ES modules)
• Server: Express 5
• Views: EJS templates
• Database: Supabase (Postgres) via @supabase/supabase-js and pg
• Dev tooling: nodemon

Getting Started

Prerequisites

• Node.js 18+
• A Supabase project (or a local Postgres database)

1. Install dependencies

npm install

2. Configure environment variables

Create a .env file in the project root:

# Supabase
SUPABASE_URL=https://your-project.supabase.co
SUPABASE_ANON_KEY=your-anon-key
SUPABASE_DB_URL=postgresql://user:password@host:5432/postgres

# Optional
PORT=3000                                  # defaults to 3000
SITE_URL=https://your-domain.com           # canonical URL for SEO

3. Set up the database

See Database Setup below to create the tables.

4. Run the application

npm start

The server starts at http://localhost:3000 (or your configured PORT).

Database Setup

Initializing the Database

Before using the application, you need to create the database tables. The application connects to Supabase Postgres.

1. Open your Supabase project dashboard
2. Go to the SQL Editor
3. Copy and paste the contents of schema.sql
4. Execute the script to create all tables, triggers, and constraints
5. (Optional) Run the contents of ddl.sql to load sample data

Alternatively, if you have a local Postgres database configured, you can use:

npm run init-db

Seed Scripts

Sales Seed Script

A ready-to-run Supabase/Postgres seeding script lives at scripts/sample_sales_seed.sql. To load sample invoices:

1. Ensure at least one employee and one active product exist (customers are optional).
2. Open the Supabase SQL editor and paste the file contents.
3. Execute the script; it inserts three invoices plus associated line items, automatically calculating totals.
4. (Optional) Run the commented SELECT at the bottom to inspect the newly inserted rows.

The script is idempotent per execution (it always creates fresh invoices) and keeps the logic lightweight while demonstrating end-to-end sales data.

Suppliers Seed Script

A simple seed script for suppliers is available at scripts/sample_suppliers_seed.sql. To populate test suppliers:

1. Open the Supabase SQL editor and paste the file contents.
2. Execute the script; it inserts five sample suppliers with contact information.
3. Run the verification query at the bottom to confirm insertion.

This provides a foundation for testing supplier-related features and supply order management.

License

Licensed under the MIT License.