Quick Start Guide

Get PosStar up and running in 5 minutes.

1Create Your Account

Visit posstar.net/register and create your free account. Choose your industry during signup to get pre-configured settings.

The free plan includes 1 store, 100 products, 2 employees, and basic POS functionality. No credit card required.

2Complete Onboarding

After login, the onboarding wizard guides you through 4 steps:

  • Store Setup — Name, address, timezone, currency
  • Products — Add your first products (or import via CSV)
  • Payment Methods — Configure cash, card, mobile payments
  • Ready! — Start selling

3Start Selling

Navigate to the POS terminal from the sidebar or use the quick POS button in the top bar. The POS supports:

  • Search — Type product name, scan barcode, or browse by category
  • Shortcuts — F2 for search, F9 for payment, Esc to close
  • Payment — Cash, card, mobile, gift card, or split

4Explore the Dashboard

The dashboard shows your sales overview, top products, recent transactions, and quick actions. Use the sidebar to navigate to Products, Inventory, Customers, Reports, and Settings.

Self-Hosted Deployment

For self-hosted deployments, use Docker Compose:

# Clone the repository
git clone https://github.com/posstar/posstar.git
cd posstar

# Start all services
docker compose up -d

# Services started:
# - API:        http://localhost:4000
# - Web:        http://localhost:3000
# - PostgreSQL: localhost:5432
# - Redis:      localhost:6379
# - MinIO:      localhost:9000

# Run database seed (optional demo data)
cd apps/api && npx ts-node src/database/seeds/seed.ts