diff --git a/figma/CONTRIBUTING.md b/figma/CONTRIBUTING.md index 05a34199..e00be251 100644 --- a/figma/CONTRIBUTING.md +++ b/figma/CONTRIBUTING.md @@ -1,12 +1,13 @@ # Contributing to assistant figma platform ## Setting up Env vars (.env) + > In most case, you won't have to specify contents or create `figma/.env` file. **Variables** -- `FIGMA_PERSONAL_ACCESS_TOKEN` - (Optional) For using figma developer tools. -- `BRIDGED_FIRST_PARTY_APP_TOTP_SECRET` - (Not Required) Used for communicating with bridged first party cloud services. set this as "s1v1-assistant-development". learn more at [base's security startegy](https://github.com/bridgedxyz/base/blob/main/docs/security.md) +- `FIGMA_PERSONAL_ACCESS_TOKEN` - (Optional) For using figma developer tools. +- `BRIDGED_FIRST_PARTY_APP_TOTP_SECRET` - (Not Required) Used for communicating with bridged first party cloud services. set this as "s1v1-assistant-development". learn more at [base's security startegy](https://github.com/gridaco/base/blob/main/docs/security.md) ## Good to know - Somethings leart from mistakes diff --git a/figma/README.md b/figma/README.md index a4a226a9..eed6b6f9 100644 --- a/figma/README.md +++ b/figma/README.md @@ -16,12 +16,15 @@ First: -``` +```sh $ yarn install -``` -``` -$ yarn run dev +# building for production - this will load production web hosted version in your plugin host +$ yarn run build + +# building for development - this will load localhost:3000/init-figma page in to your plugin host +$ yarn run build:dev +$ yarn run watch # same as `build:dev`, but in watch mode. (if you are not interacting with figma-core, you don't have to run this command.) ``` ### Installing the plugin diff --git a/xd/README.md b/xd/README.md index e39d22f1..632388a8 100644 --- a/xd/README.md +++ b/xd/README.md @@ -1,38 +1,38 @@ -# Bridged Assistant on Adobe XD - - +# Grida Assistant on Adobe XD ## references -xd plugin react [example](https://github.com/AdobeXD/plugin-samples/tree/master/quick-start-react) +xd plugin react [example](https://github.com/AdobeXD/plugin-samples/tree/master/quick-start-react) [get UXP developer tools](https://www.adobe.io/photoshop/uxp/devtool/) - [XD plugin api docs](https://adobexdplatform.com/plugin-docs/reference/xd-index.html) - # Development ## Getting started -* One time: Install nodejs (https://nodejs.org/en/download/) and yarn (npm i yarn -g) -* Open terminal and navigate to the /xd-flutter-plugin-src folder -* run `yarn` -* run `yarn build` -* Plugin files will be copied into the /build folder, and also into your XD plugin developer folder -* Refresh plugin in XD with `Ctrl+Shift+R` + +- One time: Install nodejs (https://nodejs.org/en/download/) and yarn (npm i yarn -g) +- Open terminal and navigate to the /xd-flutter-plugin-src folder +- run `yarn` +- run `yarn build` +- Plugin files will be copied into the /build folder, and also into your XD plugin developer folder +- Refresh plugin in XD with `Ctrl+Shift+R` ## Notes -* If you get errors about missing dependencies when building, you probably need to run `yarn` again -* builds are run in watch mode by default, meaning webpack re-bundles on file save + +- If you get errors about missing dependencies when building, you probably need to run `yarn` again +- builds are run in watch mode by default, meaning webpack re-bundles on file save -> add `--no-watch` to disable watch mode -* builds are automatically copied to the XD develop folder, use cmd/ctrl-shft-R in XD to reload plugins +- builds are automatically copied to the XD develop folder, use cmd/ctrl-shft-R in XD to reload plugins ## Production builds + If you are creating production builds for publishing, there are a few other things to consider: -* re-export / test the example thoroughly -* in version.js: update the `version`, `xdVersionRequired`, & set `debug` to false -* update the version in manifest.json, and ensure the README and CHANGELOG are up to date (incl. version) and committed. -* clear the `build` folder and use `yarn build --production` to minifiy and disable sourcemaps -* create the `xdx` file by zipping the _contents_ of the build folder, and renaming with a `.xdx` extension. -* once the plugin is submitted, tag the commit with it's version number (ex. `v1.0.0`) + +- re-export / test the example thoroughly +- in version.js: update the `version`, `xdVersionRequired`, & set `debug` to false +- update the version in manifest.json, and ensure the README and CHANGELOG are up to date (incl. version) and committed. +- clear the `build` folder and use `yarn build --production` to minifiy and disable sourcemaps +- create the `xdx` file by zipping the _contents_ of the build folder, and renaming with a `.xdx` extension. +- once the plugin is submitted, tag the commit with it's version number (ex. `v1.0.0`)