### Install and Run Nuxt 3 Style & Icons Showcase Source: https://context7.com/bitrix24/b24sdk-examples/llms.txt Navigate to the example directory, install dependencies, and run the development server. No Bitrix24 credentials are required for this standalone example. ```bash cd js/01-style-icons pnpm install pnpm run dev # http://localhost:3000 ``` -------------------------------- ### Setup Nuxt Hook (Webhook-authenticated server API) Source: https://context7.com/bitrix24/b24sdk-examples/llms.txt Clone the example, copy the environment file, and edit it with your Bitrix24 webhook URL. Then, install dependencies and run the development server. ```bash cd js/02-nuxt-hook cp .env.example .env # Edit .env: NUXT_B24_HOOK="https://your_domain.bitrix24.com/rest/1/xxxyyyxxx/" pnpm install && pnpm run dev ``` -------------------------------- ### Run Nuxt UI Business-Process Activity Example Source: https://context7.com/bitrix24/b24sdk-examples/llms.txt Install dependencies and run the Nuxt 3 development server for the business-process activity example. Activity descriptions are located in the `content/activities/{locale}/` directory. ```bash cd js/06-nuxt-ui-bp-activity pnpm install && pnpm run dev ``` -------------------------------- ### Install and Run Local PHP App with Token Storage Source: https://context7.com/bitrix24/b24sdk-examples/llms.txt This example demonstrates setting up a local PHP application that stores access and refresh tokens in a file. It requires Composer and npm for installation and provides instructions for registering the app with Bitrix24 using ngrok. ```bash cd php/quick-start/local-apps/token-storage-in-file composer install && npm install npm run dev # PHP server :8080 + ngrok + Tailwind # Register: Handler=https:///index.php Install=https:///install.php # Visit: https:///external.php → shows current user data ``` -------------------------------- ### Build and Start Docker Containers Source: https://github.com/bitrix24/b24sdk-examples/blob/main/php/special/biconnector/README.md Builds the Docker image and starts the application containers. Ensure Docker is installed and running. ```bash make build make up ``` -------------------------------- ### Run Nuxt OAuth Example Source: https://context7.com/bitrix24/b24sdk-examples/llms.txt Install dependencies and run the Nuxt 3 development server for the OAuth 2.0 example. Configure your Bitrix24 OAuth client ID and secret in the `.env` file. Visit `http://localhost:3000` to initiate the login flow. ```bash cd js/08-nuxt-oauth # .env – set NUXT_OAUTH_BITRIX24_CLIENT_ID and NUXT_OAUTH_BITRIX24_CLIENT_SECRET pnpm install && pnpm run dev # Visit http://localhost:3000 → click "Login with Bitrix24" ``` -------------------------------- ### Run Nuxt UI Widget Example Source: https://context7.com/bitrix24/b24sdk-examples/llms.txt Install dependencies and run the Nuxt 3 development server for the widget example. This application demonstrates building a small embeddable widget for Bitrix24 placements. ```bash cd js/07-nuxt-ui-widget pnpm install && pnpm run dev ``` -------------------------------- ### Start Development Server with bun Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/06-nuxt-ui-bp-activity/README.md Run this command to start the Nuxt development server using bun. ```bash bun run dev ``` -------------------------------- ### Start Development Server with npm Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/06-nuxt-ui-bp-activity/README.md Run this command to start the Nuxt development server using npm. ```bash npm run dev ``` -------------------------------- ### Local Environment Configuration Example Source: https://github.com/bitrix24/b24sdk-examples/blob/main/php/special/vibe24-widgets/README.md Example of how the .env.local file should be populated with Bitrix24 application credentials. Replace 'YOUR_DATA_HERE' with your actual application ID, secret, and scope. ```plaintext BITRIX24_PHP_SDK_APPLICATION_CLIENT_ID='YOUR_DATA_HERE' BITRIX24_PHP_SDK_APPLICATION_CLIENT_SECRET='YOUR_DATA_HERE' BITRIX24_PHP_SDK_APPLICATION_SCOPE='user_brief' ``` -------------------------------- ### Install Project Dependencies Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/02-nuxt-hook/README.md Run this command in your project's root directory to install all necessary dependencies. ```bash pnpm install ``` -------------------------------- ### Package JSON Configuration Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/05-node-hook/README.md This is an example of the package.json file after installing dependencies. Ensure 'type' is set to 'module' for ES module support. ```json { "name": "my-node-project", "type": "module", "devDependencies": { "@types/node": "^22.9.1", "typescript": "^5.6.3" }, "dependencies": { "@bitrix24/b24jssdk": "latest", "chalk": "^5.3.0", "dotenv": "^16.4.5" } } ``` -------------------------------- ### Local Environment Configuration Example Source: https://github.com/bitrix24/b24sdk-examples/blob/main/php/quick-start/local-apps/token-storage-in-file/README.md Example of how to configure your local environment variables in the .env.local file with your Bitrix24 application credentials. ```plaintext BITRIX24_PHP_SDK_APPLICATION_CLIENT_ID='YOUR_DATA_HERE' BITRIX24_PHP_SDK_APPLICATION_CLIENT_SECRET='YOUR_DATA_HERE' BITRIX24_PHP_SDK_APPLICATION_SCOPE='crm,user_brief' ``` -------------------------------- ### Start Development Server with yarn Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/06-nuxt-ui-bp-activity/README.md Run this command to start the Nuxt development server using yarn. ```bash yarn dev ``` -------------------------------- ### Install Dependencies with bun Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/06-nuxt-ui-bp-activity/README.md Use this command to install project dependencies using bun. ```bash bun install ``` -------------------------------- ### Install Dependencies Source: https://github.com/bitrix24/b24sdk-examples/blob/main/php/quick-start/simple/02-work-with-webhook/README.md Install project dependencies using Composer. Ensure you have Composer installed globally. ```shell composer install ``` -------------------------------- ### Start Local PHP Web Server Source: https://github.com/bitrix24/b24sdk-examples/blob/main/php/special/custom-activities/README.md Start a local PHP web server for development. This command serves files from the 'public' directory. ```shell cd public php -S 127.0.0.1:8090 ``` -------------------------------- ### Run the Nuxt Project Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/02-nuxt-hook/README.md Execute this command to start the Nuxt development server after setting up your environment variables. ```bash pnpm run dev ``` -------------------------------- ### Install Dependencies with npm Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/04-umd-frame/README.md Installs the necessary dependencies for the project using npm. This command should be run in the project's root directory. ```shell npm install ``` -------------------------------- ### Execute Webhook Script Source: https://github.com/bitrix24/b24sdk-examples/blob/main/php/quick-start/simple/02-work-with-webhook/README.md Run the PHP example script from your shell. Make sure to replace `INSERT_HERE_WEBHOOK_URL` with your actual webhook URL in the `example.php` file. ```shell php -f example.php ``` -------------------------------- ### UMD Frame Setup (PHP + Tailwind) Source: https://context7.com/bitrix24/b24sdk-examples/llms.txt Instructions for setting up a local Bitrix24 application using PHP's built-in web server, ngrok, and Tailwind CSS. The JavaScript is loaded as a UMD bundle. Ideal for learning token exchange. ```bash cd js/04-umd-frame npm install npm run dev # starts PHP web server on :8080, ngrok tunnel, and Tailwind watch # Register in Bitrix24 Developer Resources > Local application: # Handler path: https://.ngrok-free.app/index.php # Install path: https://.ngrok-free.app/install.php # Scopes: user_brief, crm ``` -------------------------------- ### Install Dependencies with yarn Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/06-nuxt-ui-bp-activity/README.md Use this command to install project dependencies using yarn. ```bash yarn install ``` -------------------------------- ### Initialize SQLite Database Source: https://github.com/bitrix24/b24sdk-examples/blob/main/php/special/biconnector/README.md Initializes the SQLite database with schema and sample data. This command should be run after starting the containers. ```bash make init-db ``` -------------------------------- ### Start Development Server with pnpm Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/03-nuxt-frame/README.md Starts the Nuxt.js development server using pnpm. The application will be accessible at http://localhost:3000/dev-folder/. ```bash # pnpm pnpm run dev ``` -------------------------------- ### Install Dependencies for Nuxt UI Widget Source: https://github.com/bitrix24/b24sdk-examples/blob/main/js/07-nuxt-ui-widget/README.md Run these commands to install project dependencies using npm, pnpm, yarn, or bun. ```bash # npm npm install # pnpm pnpm install # yarn yarn install # bun bun install ``` -------------------------------- ### JS Example 01 – Style & Icons Showcase Source: https://context7.com/bitrix24/b24sdk-examples/llms.txt A Nuxt 3 playground showcasing Bitrix24 icon components and styling primitives. No Bitrix24 credentials are required. ```APIDOC ## JS Example 01 – Style & Icons Showcase (`js/01-style-icons`) A Nuxt 3 playground that renders all `@bitrix24/b24icons-vue` icon components and tests `@bitrix24/b24ui-nuxt` styling primitives. No Bitrix24 credentials are required – it runs standalone. ```bash cd js/01-style-icons pnpm install pnpm run dev # http://localhost:3000 ``` ```ts // app/pages/index.vue – icon usage pattern import FileDownloadIcon from '@bitrix24/b24icons-vue/main/FileDownloadIcon' import CompanyIcon from '@bitrix24/b24icons-vue/crm/CompanyIcon' // Inside