Kickstart your project with the Nuxt application template — packed with multi‑page support, a collapsible sidebar, keyboard shortcuts, light/dark themes, a command palette, and more, all powered by Bitrix24 UI.
The dashboard template for Vue is on https://github.com/bitrix24/templates-dashboard-vue.
git clone https://github.com/bitrix24/templates-dashboard.git <project-name>
cd <project-name>Make sure to install the dependencies:
pnpm installThen create your local environment file from the example and fill in the values:
cp .env.example .env| Variable | Required | Description |
|---|---|---|
NUXT_PUBLIC_SITE_URL |
for prod | Public URL of the application (e.g. https://example.com). |
NUXT_APP_BASE_URL |
for prod | Application base path (e.g. / or /some-folder/). |
NUXT_ALLOWED_HOSTS |
for tunnels | Comma-separated allowed hosts for the Vite dev server (needed for ngrok and similar tunnels). |
Start the development server on http://localhost:3000:
pnpm devBuild the application for production:
pnpm buildLocally preview production build:
pnpm previewCheck out the deployment documentation for more information.
This template works both as a full-fledged Bitrix24 application and standalone.
When it is launched outside of a Bitrix24 frame (e.g. plain pnpm dev in the
browser), the Bitrix24 frame fails to initialize and the dashboard automatically
falls back to generated test data. This lets you develop and preview the UI
without a Bitrix24 account.
A browser-based application for Bitrix24.
The following permissions must be enabled in the application settings:
crm— access to CRM entities.user_brief— access to basic user profile data.tasks— access to tasks.entity— access to storage entities.
When registering the application in the Bitrix24 Partner Portal or as a local app, use the following endpoints:
| Parameter | URL |
|---|---|
| Application URL | https://your-app.example.com |
| Installation URL | https://your-app.example.com/install |
- Open your Bitrix24.
- Go to Applications -> Add Application
- Select Local Application
- Fill in the URLs provided above and check the required Scopes.
- Click Save and open the app.