You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,28 +60,34 @@ The project is configured for [pnpm](https://pnpm.io/). To install, see the [ins
60
60
61
61
The plugin is organized as a monorepo. There are several packages:
62
62
63
-
- packages/backend - Contains the business logic that reads the Figma API and converts nodes
64
-
- packages/plugin-ui - Contains the common UI for the plugin
65
-
- packages/eslint-config-custom - Config file for ESLint
66
-
- packages/tsconfig - Collection of TSConfig files used throughout the project
63
+
-`packages/backend` - Contains the business logic that reads the Figma API and converts nodes
64
+
-`packages/plugin-ui` - Contains the common UI for the plugin
65
+
-`packages/eslint-config-custom` - Config file for ESLint
66
+
-`packages/tsconfig` - Collection of TSConfig files used throughout the project
67
67
68
-
- apps/plugin - This is the actual plugin assembled from the parts in backend & plugin-ui. Within this folder it's divided between:
69
-
- plugin-src - loads the backend and compiles to code.js
70
-
- ui-src - loads the common plugin-ui and compiles to index.html
71
-
- apps/debug - This is a debug mode plugin that is a more convenient way to see all the UI elements.
68
+
-`apps/plugin` - This is the actual plugin assembled from the parts in `backend` & `plugin-ui`. Within this folder it's divided between:
69
+
-`plugin-src` - loads from `backend` and compiles to `code.js`
70
+
-`ui-src` - loads the common `plugin-ui` and compiles to `index.html`
71
+
-`apps/debug` - This is a debug mode plugin that is a more convenient way to see all the UI elements.
72
72
73
73
The plugin is built using Turbo which in turn builds the internal packages.
74
74
75
75
#### Commands
76
76
77
77
`pnpm run ...`
78
78
79
-
-`dev` - runs the app in dev mode
79
+
-`dev` - runs the app in dev mode. This can be run in the Figma editor.
80
80
-`build`
81
81
-`build:watch`
82
82
-`lint`
83
83
-`format` - formats with prettier (warning: may edit files!)
84
84
85
+
#### Debug mode
86
+
87
+
When running the `dev` task, you can open `http://localhost:3000` to see the debug version of the UI.
88
+
89
+
<imgwidth="600"alt="Screenshot 2024-12-13 at 16 26 43"src="https://github.com/user-attachments/assets/427fb066-70e1-47bd-8718-51f7f4d83e35" />
90
+
85
91
## Issues
86
92
87
93
The Figma file for this README and icon is also open and welcome to changes! [Check it here.](https://www.figma.com/file/8buWpm6Mpq4yK9MhbkcdJB/Figma-to-Code)
0 commit comments