Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ProyectoFerretek/FerreMarket/llms.txt

Use this file to discover all available pages before exploring further.

FerreMarket is a modern, full-stack management system built for hardware stores and construction material shops. Built with React, TypeScript, and Supabase, it gives store operators a single dashboard to manage every aspect of daily operations — from tracking inventory and processing sales to managing customers and generating PDF invoices.

Quick Start

Clone the repo, configure your environment, and have FerreMarket running locally in minutes.

Configuration

Set up Supabase, Auth0, and Cloudflare credentials via environment variables.

Core Modules

Explore the Dashboard, Products, Sales, Customers, Promotions, and Reports modules.

Reference

TypeScript data models, Supabase schema, utility functions, and auth helpers.

​
Key Features

Inventory Management

Real-time stock tracking with low-stock alerts, category filtering, SKU lookup, and supplier reorder requests.

Sales & Invoicing

Create sales, apply promotions, generate PDF invoices with jsPDF, and send receipts by email.

Customer CRM

Manage individual clients (RUN) and business accounts (RUT/giro) with full purchase history.

Promotions Engine

Percentage and fixed-amount discount codes with usage limits, date ranges, and customer-type targeting.

Reports & Analytics

Sales KPI dashboard with Recharts graphs, critical-stock inventory reports, and PDF/Excel exports.

Role-Based Access

Three-tier permission system (admin / usuario / cliente) enforced through Supabase Auth and custom guards.

​
Getting Started

1

Clone and install

Clone the repository and install Node.js dependencies.
git clone https://github.com/ProyectoFerretek/FerreMarket.git
cd FerreMarket
npm install
2

Configure environment

Copy .env.example to .env and fill in your Supabase URL, Supabase anon key, and Cloudflare credentials. See the Configuration guide for details.
3

Start the dev server

npm run dev
The app will be available at http://localhost:5173.
4

Log in and explore

Navigate to http://localhost:5173/admin/login and sign in with your Supabase credentials. The Dashboard is your starting point for daily operations.

​
Tech Stack

LayerTechnology
FrontendReact 18, TypeScript, Tailwind CSS
Build toolVite
Backend / DatabaseSupabase (PostgreSQL + Edge Functions)
AuthenticationSupabase Auth
ChartsRecharts
PDF generationjsPDF + jspdf-autotable
File storageCloudflare R2 via Workers
IconsLucide React
Date handlingLuxon

Build docs developers (and LLMs) love

Get started for freeTalk to us