Documentation
StockFlow Docs
Everything you need to set up your team, manage inventory, and get the most out of StockFlow.
Getting Started
Create your account
Go to /sign-in and sign up. On your first login you'll land on onboarding — give your organization a name and you're ready to go. The first user becomes a Manager automatically.
Invite your team
Open Members and invite teammates by email. When they sign in they'll see a pending invitation and can join your organization as Staff with one click.
Add your first product
Press N or click '+ Add Product'. Enter a name, quantity, and price. Optionally add a SKU, photo, category, and a low stock threshold to get alerted before you run out.
Your dashboard at a glance
The dashboard shows total SKUs, inventory value, low stock count, out-of-stock count, and in-stock percentage. Managers also see a daily digest and a 12-week trend chart.
Inventory
Table view and gallery view
Switch between a detailed table and a visual gallery using the icon in the toolbar. Your preference is saved across sessions.
Search and filter
Search by product name using the search bar, or press ` to jump straight to it. Filter by status — All, In Stock, Low, or Critical — to focus on what needs attention.
Category folders
Assign a category to any product and it appears in the folder panel on the left. Click a folder to see only that category. Items without a category are grouped under Uncategorized.
Edit a product
Click the pencil icon on any row to open the edit form. Update the name, price, quantity, SKU, category, low stock threshold, or image. Changes save instantly.
Delete a product
Click the trash icon to remove a product. If it had stock remaining, an anomaly alert is created automatically and the action is recorded in the audit log.
Export to CSV
Managers can export the full inventory list as a CSV file from the toolbar. Includes name, SKU, category, price, quantity, and status.
Live sync across devices
Any change made by a teammate appears on your screen instantly — no refresh needed. Everyone always sees the same data.
Dispatch
Dispatching stock
Go to Dispatch (press D or click Dispatch in the sidebar). Pick a product, enter the quantity going out, and optionally add a reason like Sold, Damaged, or Transferred.
What happens after a dispatch
Stock is reduced immediately. If the new quantity hits a low stock threshold or drops more than 30% in one go, an alert is created automatically.
Alerts
Low stock alerts
When a product's quantity falls to or below its threshold, an alert is created. Only one active low stock alert exists per product at a time — no duplicates.
Anomaly alerts
If stock drops more than 30% in a single update, or a product with stock is deleted, an anomaly alert is created so nothing slips through unnoticed.
The alert bell
The bell icon in the sidebar shows how many unread alerts you have. Click it or press A to go to the Alerts page.
Dismissing alerts
Dismiss alerts one by one or clear them all at once with Dismiss All. Dismissed alerts stay in the list so you have a record.
Team & Roles
Three roles, clear boundaries
Staff can view and edit inventory, dispatch stock, and check alerts. Managers can also invite members, approve requests, export data, and access the audit log. Super Admins get everything plus system monitoring.
Inviting members
Managers invite people by email from the Members page. The invitee sees a pending invitation on their dashboard and joins as Staff.
Approvals
Role changes and member removals go through an approval step. Managers review and approve or reject requests at /org/approvals — keeping changes deliberate and traceable.
Leaderboard
Earning points
Every action earns points: +10 for adding a product, +5 for updating one, +1 for checking inventory. Points add up over time.
Badges
Reach milestones and earn badges automatically — First Product, Hundred Updates, Inventory Checker, and more. Badges show on your profile.
Team rankings
The leaderboard ranks everyone by total points. Your own position is highlighted. If you're outside the top group, your rank still shows at the bottom.
Org Settings
Organization name
Managers can rename the organization from /org/settings. The updated name shows in the sidebar and topbar right away.
Display currency
Pick the currency your team works in — MNT, USD, EUR, CNY, JPY, KRW, or GBP. All monetary values across the app update instantly.
Delete organization
Permanently removes the organization and all its data. This cannot be undone — use with care.
Audit Log
What gets logged
Every product create, update, and delete is recorded with the before and after values. Membership actions — invites, role changes, removals — are logged too.
Filtering the log
Filter by action type (Create, Update, Delete, Role Change, Membership), entity type, or date range to find exactly what you're looking for.
Pagination
The log loads 50 entries at a time. Click Load more to go further back in history.
Daily Digest
Your daily summary
Managers see a digest card on the dashboard each morning: total inventory value, new products added, dispatches made, alerts created, and alerts resolved — all from the previous day.
When it refreshes
The digest updates automatically at 09:00 Ulaanbaatar time (UTC+8) every day.
Who sees it
The digest is visible to Managers and Super Admins only.
Keyboard Shortcuts
N — New product
Jump straight to the Add Product form.
D — Dispatch
Open the Dispatch page.
A — Alerts
Go to the Alerts page.
` (backtick) — Search
Focus the search bar on the Inventory page.
? — Shortcuts panel
Open the full keyboard shortcuts reference.
Account
Profile and security
Update your display name, email, password, and connected accounts at /settings.
Language
Switch between English and Mongolian using the language switcher at the bottom of the sidebar.
Monitoring
Grafana dashboard
Super Admins can view system health metrics at /admin/monitoring via an embedded Grafana dashboard.
Prometheus metrics
The /api/metrics endpoint exposes Prometheus-format metrics, protected by a bearer token set in METRICS_SECRET.