Ferromax ERP is an integrated management platform built for Argentine hardware stores (ferreterías). It combines a Spring Boot REST API backend with a React frontend to deliver a point-of-sale terminal, real-time inventory tracking, automated invoice processing, and a consumer-facing online store — all in a single cohesive system.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/DragonesMagicos/ferromax_v0.8/llms.txt
Use this file to discover all available pages before exploring further.
Quick Start
Get Ferromax ERP running locally in under 10 minutes with PostgreSQL, Maven, and Node.
Architecture
Understand the full-stack structure: Spring Boot backend, React frontend, JWT auth, and WebSocket layer.
API Reference
Explore every REST endpoint with request/response schemas, auth requirements, and curl examples.
User Roles
Learn how Admin, Empleado, and Cliente roles map to features and API access.
Core Modules
Dashboard
KPI cards, weekly sales charts, and real-time stock alerts for admins.
POS Terminal
Barcode-scanner workflow for fast in-store sales processing.
Inventory
Remito-based goods receipt, manual stock adjustments, and movement audit trail.
Storefront
Public e-commerce catalog with cart, checkout, and order tracking.
Invoice Scanning
Upload supplier invoices as PDF or image — OCR extracts line items automatically.
Configuration
Environment variables, database setup, JWT configuration, and CORS settings.
Get Started in 4 Steps
Set up PostgreSQL
Create the
ferromax_db database and configure credentials in src/main/resources/application.properties.Start the backend
Run
mvn spring-boot:run from the project root. The API will be available at http://localhost:8081/api.Start the frontend
Run
npm install && npm run dev from the ferromax-web/ directory. The app opens at http://localhost:5173.Log in
Use the default admin credentials (
[email protected] / admin123) to access the dashboard, or the employee credentials ([email protected] / emp123) to open the POS terminal.Product images (~213 MB) are not included in the repository. Copy the contents of
img.zip (available from the development team) into ferromax-web/public/img/ before starting the frontend.