Getting Started
Welcome to Borkol
What the Borkol dashboard is, how to log in, and a tour of the workspace.
View as MarkdownThe Borkol dashboard at app.borkol.com is where you run your business: manage products, orders, stock, and customers, invite teammates, and connect your storefront to the Borkol API. Everything you see is scoped to the business you have selected in the header, so if you belong to more than one business, switch first and the whole dashboard follows.
Log in
Go to app.borkol.com and enter your email and password. If you forgot your password, click Forgot password? next to the Password field to request a reset link by email.
Borkol is invite-only: you get access when a platform admin sets up your account or when an account owner invites you to their team. The invite arrives by email as a link that is valid for 7 days. Opening it takes you to the Accept invite page:
- New to Borkol? Fill in a name and password. You are logged in immediately and land on the dashboard of your first business.
- Already have a Borkol account with this email? Leave the name and password fields empty and just accept. The invite is linked to your existing account and you are sent to the login page to sign in with your usual password.
See Team for how invites are sent and managed.
If self-service registration is open, the login page shows a Don't have an account? Create one link. When it is closed, the registration page says "Borkol is currently invite-only" with a contact address instead.
The workspace tour
Header
The top bar is always visible and holds, left to right:
| Control | What it does |
|---|---|
| Borkol logo | Returns to the dashboard home. |
| Business switcher | A pill showing the active business. Open it to see every business you belong to (under the Business: label) and switch; a check mark shows the current one. Switching reloads all data for the new business. If you were just added to a new business, log out and back in to see it in the list. |
| Language switcher | Flag button. Choose English, Nederlands, or Türkçe; the page refreshes in that language. |
| Notifications bell | Shows an unread-count badge (capped at "99+"). Opening it lists your 15 most recent notifications; clicking an unread one marks it read (it does not navigate anywhere), and Mark all read clears the badge at once. |
| Theme toggle | Sun/moon button with Light, Dark, and System options. |
| Account menu | Your avatar and name. Shows your name and email, with Settings, What's new (this changelog, rendered inside the dashboard in your language; also under Workspace in the sidebar) and Log out. |
Sidebar
The left sidebar has two sections:
- The top section starts with Dashboard, followed by one entry per navigation group that has at least one enabled module: Sales (quotes, invoices, payments, sales settings), Catalog (products, categories, media), Webshop (orders, carts, discounts, store settings), Operations (stock), Content (custom objects), and Contacts, which is always present. Modules are enabled per business by the platform admin; you cannot enable them yourself. A group whose modules are all disabled does not appear. Groups expand with a chevron, and the branch containing the page you are on opens automatically.
- The WORKSPACE section holds API keys and Settings.
The Collapse sidebar button at the bottom shrinks the sidebar to an icon rail; hovering an icon shows a flyout with that group's sub-pages. Your collapse and expansion choices are remembered in this browser. On small screens the sidebar becomes a drawer behind the menu button in the header.
If the navigation fails to load, a red Couldn't load navigation. banner appears with a Retry button; until it loads, only Dashboard and the Workspace entries show.
The dashboard home
The home screen is an overview for the active business.
KPI cards
Three stat cards appear when the Commerce module is enabled:
| Card | Meaning |
|---|---|
| Revenue | Total revenue, all time. |
| Orders | Total number of orders, all time. |
| Orders this month | Orders placed in the current month. |
If Commerce is not enabled for this business, the KPI cards, recent orders, and low stock sections are hidden entirely.
Recent orders
The latest orders with their number, status, total, and date placed. Click a row to open the order, or View all to go to the full Orders list. Order statuses you will see here:
| Status | Meaning |
|---|---|
pending_payment | Placed, awaiting payment. |
paid | Payment received. |
shipped | On its way to the customer. |
completed | Fulfilled and closed. |
cancelled | Cancelled. |
refunded | Refunded. |
Low stock
When the Stock module is enabled, a card lists products at or below their stock threshold, with the quantity shown in red at 0 and amber otherwise. View all opens the Stock module. Without the Stock module this card is hidden and the recent orders card takes the full width.
Modules
A grid of cards, one per enabled module, showing the module name and version. Clicking a card opens that module. If nothing is enabled you see "No modules enabled. Ask your platform admin."
Getting started checklist
Brand-new businesses (Commerce enabled, zero orders, zero products) see a Getting started card with three links:
- Create your first product — opens the new-product form.
- Configure taxes & shipping — currently opens the Orders list. The actual tax settings live under Settings → Taxes (see Taxes), and shipping under Webshop → Settings → Shipping; see Store settings.
- Create an API key for your storefront — opens Settings; the keys themselves are on the API Keys tab there. See API keys.
Click Dismiss to hide the card. Dismissal is remembered per business, per browser, so the card can still appear on another device until you dismiss it there too.
Next step
Follow the Quick start to go from an empty business to your first order.