Skip to main content

Getting Started

This guide will help you integrate Buildocs UI Engine into your application and render your first dynamic interface.

Buildocs UI Engine is designed for applications where the backend controls UI behavior at runtime — forms, tables, nested modals, workflows, document actions, and complex business processes.

Your frontend renders the interface. Your backend defines what happens.

Requirements​

Before starting, make sure your project meets the following requirements:

  • Node.js 18 or higher
  • npm 9 or higher
  • React 18 or higher
  • TypeScript 4.9.5 or higher
  • A Buildocs UI Engine account

Install the SDK​

Install the SDK together with all required peer dependencies.

npm install @buildocsdev/sdk@latest react-pdf@^10.3.0 @emotion/react@^11 @emotion/styled@^11 @mui/material@^5 @mui/icons-material@^5 @mui/system@^5 @mui/x-tree-view@^7 @react-spring/web@^9.7.4 @reduxjs/toolkit@^2.0.0 axios@^1.0.0 bootstrap@^5.3.8 i18next@^25 i18next-http-backend@^3.0.5 react-hook-form@^7.66.1 react-icons@^5.5.0 react-i18next@^16 react-redux@^9.0.0 react-router-dom@^6.4.1 react-toastify@^9.0.0 xlsx@^0.18.5 --force

or using yarn:

yarn add @buildocsdev/sdk@latest react-pdf@^10.3.0 @emotion/react@^11 @emotion/styled@^11 @mui/material@^5 @mui/icons-material@^5 @mui/system@^5 @mui/x-tree-view@^7 @react-spring/web@^9.7.4 @reduxjs/toolkit@^2.0.0 axios@^1.0.0 bootstrap@^5.3.8 i18next@^25 i18next-http-backend@^3.0.5 react-hook-form@^7.66.1 react-icons@^5.5.0 react-i18next@^16 react-redux@^9.0.0 react-router-dom@^6.4.1 react-toastify@^9.0.0 xlsx@^0.18.5