Documentation

🚀 Quick Start

If this is your first time using MiniERP, we recommend the following setup steps:

1. System configuration: Go to "System Settings" and fill in your company name, address, phone, email, bank details, and upload your logo.
2. Add customers: In "Customer Management," add customers and classify them as domestic or export, with contact information.
3. Add products: In "Product Management," maintain your product catalog with Chinese/English names, specifications, units, and HS codes (optional).
4. Add suppliers: In "Supplier Management," add suppliers to use for purchase orders.
5. Create a quotation: From "Inquiry Management" or directly, create a quotation, select the customer and products, and generate a PDF to send.
6. Convert to an order: Once the customer confirms, create an order from the quotation; export orders can generate a job sheet with one click.

📦 Deployment Guide

MiniERP supports self-hosted deployment on a modern Node.js-based stack with a SQLite database.

Requirements

• Node.js 18+ or Bun 1.0+
• Windows / Linux / macOS
• Recommended: 2GB+ RAM, 500MB+ disk space

Installation Steps (Basic Plan)

1. Obtain the installation package (source code or a pre-built build)
2. Extract it to your target directory
3. Install dependencies: bun install or npm install
4. Run database migrations (if applicable)
5. Start the server: bun run dev or npm run dev
6. Open your browser at http://localhost:4321 (port may vary based on your configuration)

Detailed deployment documentation is included with the installation package. For the Professional plan, we handle deployment for you.

📋 Business Workflow

A typical international trade workflow:

• Inquiry → customer sends an inquiry, recorded in the system
• Quotation → create a quotation, generate a PDF, send to the customer
• Order → customer confirms, convert the quotation into an order
• Job sheet → generate a job sheet from the order and assign suppliers
• Purchasing → generate purchase orders grouped by supplier, send to suppliers
• Receiving → supplier ships goods, record receiving, accounts payable generated automatically
• Shipping → create an outbound shipment, generate the Commercial Invoice and Packing List
• Payment → customer pays, record the payment, and reconcile accounts receivable

❓ Frequently Asked Questions

Q: Does it support multiple users?
A: Yes, there's no limit on the number of users, and you can create multiple operator accounts as needed (subject to the permissions module in your version).

Q: Where is the data stored?
A: In a self-hosted deployment, data is stored in a local SQLite database on your own server, fully under your control.

Q: Can I export data?
A: The database is SQLite and can be backed up directly, or exported to formats like Excel through the system's export feature (where available).

Q: Does it support multiple currencies?
A: Yes. Quotations, orders, and invoices all support currency selection (USD, CNY, EUR, and others).

Q: What is a UDID?
A: Every core document (quotation, invoice, packing list, purchase order, job sheet) automatically receives a unique identifier (format XXXX-XXXX-XXXX) for traceability and anti-counterfeiting.