- Sketch
- Node >=6.9.5 and NPM
- skpm
This plugin is built using spkm. Go ahead and get familiar with it. For development just know it's:
- Essentially just A Webpack development setup
- A React app that talks to the Sketch environment
- Entirely ES6 friendly
To get started, set up an .env
file with the following keys (fill in the values yourself):
SITE_URL=
API_URL=
API_CLIENT_KEY=
SEGMENT_WRITE_KEY=
DEV_BASIC_AUTH= // optional
Afterward you can get set up by running the following command.
// Install the dependencies
npm install
// Once the installation is done, you can run some commands inside the project folder:
npm run build
// To watch for changes:
npm run watch
// Additionally, if you wish to run the plugin every time it is built:
npm run start
This will change in the future but for now just do the following:
- Version bump in
package.json
- Delete your build folder and run
NODE_ENV=production npm run build
to get a production version of the code - Zip it and create a Release