Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Luisangelebp/SCO_Autolavados/llms.txt

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

SCO Autolavados is an operational management system designed for car wash businesses (autolavados) in Venezuela. It provides an Admin dashboard for internal operations and a Customer-facing portal for online orders and reservations, all backed by a REST API built with Node.js, Express, Prisma ORM, and PostgreSQL. The platform handles multi-currency transactions in USD and Venezuelan Bolívares, with automatic BCV exchange rate fetching.

Introduction

Learn what SCO Autolavados is and how all the pieces fit together.

Quickstart

Clone the repo, configure environment variables, and have the system running in minutes.

API Reference

Explore every REST endpoint with request/response schemas and usage examples.

Architecture

Understand the client-server design, Docker setup, and database schema.

Core Modules

Users & Roles

Admin, Customer, and Laundrer roles with differentiated access flows.

Service Queue

Real-time wash queue with estimated wait-time algorithm.

Reservations

Customer booking portal with auto-queue cron pipeline.

Inventory

Stock control with automatic deduction on sales.

Payments & Sales

Multi-currency POS, payment approval, and invoice generation.

Payroll

Daily commission pool calculation for laundry operators.

Get Running in 3 Steps

1

Clone and configure

Clone the repository and copy the environment template.
git clone https://github.com/Luisangelebp/SCO_Autolavados.git
cd SCO_Autolavados
cp .env.example .env  # Fill in DB credentials and JWT_SECRET
2

Start with Docker Compose

Spin up the database, backend API, and frontend web app.
docker compose up --build
The API is available at http://localhost:3000 and the frontend at http://localhost:5173.
3

Login and explore

Use the seeded admin credentials to log in and explore the dashboard.
curl -X POST http://localhost:3000/api/users/login \
  -H "Content-Type: application/json" \
  -d '{"identifier": "admin", "password": "admin123"}'
All API endpoints are prefixed with /api. Authenticated endpoints require a JWT Bearer token obtained from POST /api/users/login.

Build docs developers (and LLMs) love