Getting Started
In order to use the
Generating boilerplate and install dependencies
To setup your first app template layout, you need to have NodeJS installed including access to npx command line
npx xircus dust-template
Installed Dependencies
TanStack Query
Xircus SDK & Xircus React
Xircus TON React
Dust
Dust Chakra
Dust Chakra Component
The DUST Architecture
Name | Description |
---|---|
Dust | The block editor provider, fully integrated with Xircus React & SDK. Contains pre-built functions for reusability DustProvider - loads all necessary data to compose the page and blocks |
Dust Chakra | The chakra UI provider for Dust. DustEditor - in-app editing controls (optional) DustChakraProvider - manages the chakra UI and layouts that is built on Chakra components |
Dust Radix | TBD |
Dust Material | TBD |
Dust Chakra Components | Contains UI components that can be integrated with any blocks. Contains the following blocks: Common Blocks |
The DustProvider
The DustComponent component
The Structure
Folders | ||
---|---|---|
components-* | Contains all bare components | |
blocks-* | Contains the UI blocks | |
layouts-* | ||
presets-* | ||
hooks | ||
services | Contains non-hook api calls | |
Last updated