Skip to content

Bricks is an open source tool for converting Figma designs into high-quality frontend code.

License

Notifications You must be signed in to change notification settings

bricks-cloud/bricks

Repository files navigation

Bricks: Design to Code For Developers

Bricks is an open source tool for converting Figma designs into high-quality frontend code.

PRs Welcome Github Stars Join Bricks on Discord License GitHub commit activity

Check out our demo video!

Getting Started

Development Version

VSCode extension:

  1. Make sure that you have installed Node.js and Yarn 1.
  2. Clone our VSCode extension.
  3. Run yarn install in the repository's root directory.
  4. Click on "Run" and select "Start Debugging" to start the VSCode extension in development mode.
  5. Click on "Activate Bricks" in VSCode's status bar in the right corner.
  6. Proceed to start the Figma plugin.

Figma plugin:

  1. Install Node.js and Yarn 1.
  2. Run yarn install in the repository's root directory.
  3. Right Click in Figma -> "Plugins" -> "Development" -> "Manage plugins in development"
  4. Click on "+" -> import plugin from manifest -> Select bricks/figma/dist/manifest.json file to import the plugin
  5. Click on "Run" and select "In-development version" to start the Figma plugin in development mode.
  6. After activating Bricks' VSCode extension, start selecting components and click on "Generate" button to start generating code.

Production Version

  1. Install Node.js.
  2. Install both the VSCode extension and the Figma plugin.
  3. Click on "Activate Bricks" in VSCode's status bar in the right corner to activate the extension.
  4. In Figma, select components to convert to code.
  5. Click “Generate”.
  6. Done! The generated code shows up in VS Code, along with a live preview.
  7. You can tinker with the generated code, and see changes instantly in the preview
  8. When you’re happy with the code, just drop it into your codebase 👏

Project Structure

Bricks is composed of a number of components. Below is a description of each component:

  • figma: the Figma plugin for Bricks.
  • core: the engine that converts Figma nodes into coding files.

Related Projects

License

Distributed under the Apache 2.0 License and Bricks Enterprise License. See LICENSE for more information.

Get in Touch

Email: spike@bricks-tech.com

Join Bricks on Discord