Nuxt Starter Template

Use this template to get started with Bitrix24 UI quickly.

• Live demo
• @bitrix24/b24ui
• @bitrix24/b24icons
• @bitrix24/b24jssdk

The starter template for Vue is on https://github.com/bitrix24/starter-b24ui-vue.

Quick Start

git clone https://github.com/bitrix24/starter-b24ui.git <project-name>
cd <project-name>
pnpm install
pnpm run dev

Setup

Make sure to install the dependencies:

pnpm install

Development Server

Start the development server on http://localhost:3000:

pnpm dev

Code Quality

Lint the codebase:

pnpm lint

Run type checking:

pnpm typecheck

Run the tests (powered by Vitest and @nuxt/test-utils):

pnpm test

Environment Variables

Copy .env.example to .env and adjust the values as needed:

cp .env.example .env

Variable	Description
NUXT_ALLOWED_HOSTS	Comma-separated list of extra hosts allowed by the Vite dev server. Useful when exposing the dev server through tunnels like ngrok.

Production

Build the application for production:

pnpm build

Locally preview production build:

pnpm preview

Check out the deployment documentation for more information.