-
-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
90490b4
commit 80db25f
Showing
3 changed files
with
31 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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`) |