Please note: this plugin makes use of a specific Figma Teams Library, which you can find here. Wihtout it the plugin will fail to find the components and not run as expected.
First you will need to instsall the Figma desktop app, now all you have to do is follow these two simple steps and you'll be ready to use the plugin:
-
Open the app, login and go to the "Plugins" menu, "In Development" and click on the plus icon.
-
Click to add the
/manifest.jsonfile found in the root of this repo. -
The pluign has been installed, to run it you need to open a document, and go to "Plugins" -> "Development" -> "Ipsos project v2"
The main plugin code is in src/code.ts. The HTML for the UI is in
src/ui.html, while the embedded JavaScript is in src/ui.js and the Vue script is in src/App.vue.
These are compiled to files in build/, which are what Figma will use to run
your plugin as set in the manifest.json.
To build and run the plugin you will need to have the Figma desktop app (the web browser version does not work for development) and Node.JS with npm installed in your machine.
Once you have installed node JS go to the root of this repo and type in the following commands in your terminal:
$ npm install
$ npm run watch
This will create a Node server that builds the plugin live as it is saved, useful for development purposes.