StoreFlow POS - NestJS Retail Management

StoreFlow POS

StoreFlow is a self-hosted retail management system for point of sale, inventory, purchasing, customers and accounting. The package includes a NestJS API with PostgreSQL and a Next.js/React administration and checkout interface. Both projects include readable TypeScript source.

Retail workflow

Process sales with product or barcode search, parked carts, split payments, receipts, returns and exchanges. Track stock by warehouse and batch, receive purchase orders, record supplier and customer balances, and review sales, inventory and financial reports.

Administration

Manage products, pricing, taxes, coupons, staff permissions, duty schedules and audit logs. PostgreSQL migrations and sample data support setup; Swagger API documentation and an installation guide are included.

What is included

• NestJS backend and Next.js frontend source code
• Database migrations and setup examples
• Installation and deployment documentation

Production deployment requires your own server, PostgreSQL database and environment credentials. Optional scanners and printers are supplied separately.

Features

Point of Sale Terminal

• Fast new sale screen - search by name, SKU or barcode
• USB barcode scanner support (plug and play, no driver)
• Hold / park carts and resume them later
• Split and multiple payment methods (cash, card, mobile banking, custom)
• Returns, refunds and exchanges against the original invoice
• Collect customer dues at the counter
• Automatic offers and discount coupons
• Thermal receipt printing (58 mm / 80 mm) and PDF receipts
• Sales history with reprint and void (fully audited)

Products & Catalogue

• Products with images, pricing and tax
• Categories and sub-categories, brands, measurement units
• Barcode generation and printable barcode label sheets (PDF)
• Bulk Excel import with templates, and Excel export
• Non-refundable product flag

Inventory

• True FIFO batch costing - real cost of goods and real margin
• Multiple warehouses with location blocks
• Stock reservations for confirmed orders
• Stock adjustments with reason and user recorded
• Damaged products and supplier damage claims
• Low-stock alerts and stock forecasting
• Full stock movement trail

Purchasing & Suppliers

• Purchase orders (create, send, void)
• Goods receiving against orders, partial receipts and drafts
• Supplier profiles and supplier ledger
• Payables with payment vouchers

Customers & Accounting

• Customer records and customer types (retail, wholesale, VIP)
• Credit sales and due tracking
• Receivables and payables with aging analysis
• Expenses by category with printable vouchers
• Ledger entries, exportable to Excel

20+ Reports (all export to Excel)

• Sales: summary, daily sales, total sell, user collection, below-cost sales
• Inventory: inventory report, current stock value, stock position (summary and detailed), low stock
• Customers: customer report, ledger, receivables, due list and due detail
• Purchasing: monthly purchases, purchase summary, by supplier, outstanding purchases, supplier ledger
• Financial: financial summary, expenses by category, payment method breakdown, receivables and payables aging

Staff & Security

• Unlimited custom roles built from a granular permission matrix
• Permissions enforced by both the UI and the API
• Duty schedules with clock in / clock out
• Complete audit log (who, what, when)
• JWT access and refresh tokens, bcrypt password hashing
• Helmet security headers, request validation, gzip compression

Technology & Customisation

• Backend: NestJS 11, PostgreSQL, TypeORM migrations, Swagger API docs
• Frontend: Next.js 16 (App Router), React 19, TypeScript, Tailwind CSS 4
• Dashboard with sales and stock overview (optional Redis cache)
• Rebrand via environment variables: product name, logos, tagline
• Colour theme controlled by CSS variables in one file
• Shop details, receipt logo and receipt footer editable from Settings
• 100% readable source code - no license checks, no encryption, no obfuscation

Requirements

• Node.js 20 LTS or newer
• npm 10 or newer
• PostgreSQL 14 or newer (MySQL and SQLite are not supported)
• A VPS or cloud server for production (Ubuntu recommended, 2 GB RAM is enough for one shop)
• PM2 and Nginx recommended for production (guide included)
• Any modern browser; Chrome or Edge recommended for the POS terminal
• Optional hardware: USB barcode scanner, 58/80 mm thermal receipt printer, label printer

Note: this is a Node.js application, not a PHP script. It will not run on cPanel shared hosting.

Instructions

Full step-by-step instructions are in documentation/index.html inside the download. Quick start:

1. Database

1. Create an empty PostgreSQL database and a user that owns it.

2. Backend (NestJS API)

1. cd backend
2. npm install
3. cp env.example .env then set DB_HOST, DB_USERNAME, DB_PASSWORD, DB_DATABASE and JWT_SECRET
4. npm run migration:run - builds the full database schema (no SQL file to import)
5. npm run seed:install - creates the admin account and reference data
6. npm run start:dev - API runs on http://localhost:5065, Swagger docs at /api/docs

3. Frontend (Next.js Admin Panel & POS)

1. cd frontend
2. npm install
3. cp .env.example .env then set NEXT_PUBLIC_API_URL=http://localhost:5065
4. npm run dev - panel runs on http://localhost:4000

4. Log in

1. Username: admin
2. Password: the ADMIN_DEFAULT_PASSWORD value from backend/.env - change it after first login.

5. Production

1. Build both apps with npm run build.
2. Run them with PM2, put Nginx in front, and enable free SSL - the full Ubuntu walkthrough is in the documentation.
3. NEXT_PUBLIC_* variables are read at build time, so rebuild the frontend after changing the API URL.