React Bricks CLI
The CLI is the fastest way to start with React Bricks.
Launch the CLI
With Yarn > 0.25 you can also use
yarn create reactbricks-app
Once you signed up for a free trial, you can launch the CLI, which will guide you step-by-step in the creation of your first React Bricks app.
The steps the CLI will follow are:
- Choose an App or create a new one
- Enter Project name and folder name
- Choose a Starter project
- Choose to load some default content (only for starters with Tailwind CSS)
When the CLI has finished
Once the CLI has completed the scaffolding of your project, you'll be prompted to enter the project directory and run it (usually
yarn start or
yarn dev based on the environment).
When the app starts, we suggest that you explore the Admin Dashboard, going to the
/admin path or clicking on the "Edit content" button in the header menu.
If you chose to load some default content, you'll be able to edit the default pages created by the CLI.
Explore the directory structure
Take a minute to explore the folder structure of your project. It is different based on the starter project that you chose.
adminfolder where the admin interface lives
react-bricksfolder where there is the configuration of React Bricks and, in particular, the
react-bricks/bricksfolder where you will create your custom content blocks.