Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Eleazarguitar18/kantuta_pos_front/llms.txt

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

Kantuta POS is a modern, role-aware point-of-sale frontend built with React 19 and TypeScript. It connects to a NestJS REST API to centralize retail commerce and banking correspondent operations on a single platform — from ringing up sales and tracking stock to processing mobile top-ups and bank agent transactions.

Quick Start

Clone the repo, configure your API URL, and run the dev server in minutes.

Configuration

Environment variables, API base URL setup, and environment-specific builds.

Core Modules

Explore Inventory, Sales POS, Cash Registers, Recargas, and Agent modules.

API Reference

Full REST API endpoint reference with request/response schemas and examples.

What’s Inside

Kantuta POS is organized into focused business modules, each with its own service layer, TypeScript interfaces, and React components:

Inventory

Products, categories, purchase orders, barcode search, and low-stock alerts.

Sales & POS

Cart management, multi-payment methods, real-time stock sync via Socket.IO.

Cash Registers

Open/close shifts, internal movements, and balance reconciliation.

Recargas

Mobile top-ups for Tigo, Entel, and Viva with wholesale injection support.

Banking Agents

BCP/Tigo Money deposits, withdrawals, and QR transfers.

Reports

PDF reports: cash movements, sales, purchases, inventory, and productivity.

Getting Started

1

Clone the repository

git clone https://github.com/Eleazarguitar18/kantuta_pos_front.git
cd kantuta_pos_front
2

Install dependencies

npm install
3

Configure the API URL

Create a .env file at the project root:
VITE_API_URL=http://localhost:3000/api
4

Start the development server

npm run dev
The app will be available at http://localhost:5173.
Kantuta POS is designed to run on Debian 12 but works on any platform that supports Node.js 18+. See the Configuration guide for environment-specific setup details.

Build docs developers (and LLMs) love