README.md

Synopsis

Installation

Downloading a Release

1. Download the latest release
2. Go to Settings » Add-ons inside Local (1.1.0 or newer) and click on Install Add-on
3. Browse to the downloaded release
4. Check the checkbox by the Volumes addon to enable it
5. Restart Local

Cloning

Place the repository into the following directory depending on your platform:

• macOS: ~/Library/Application Support/Local by Flywheel/addons

Developing

Installing Dev Dependencies

npm install

Folder Structure

All files in /src will be transpiled to /lib using Babel. Anything in /lib will be overwritten.

Transpiling

npm run-script build

Babel, transpiling, ES6, Node.js, what?

Not familiar with some or any of these terms? Here are a few resources to get you up to speed.

• Node.js
  • The Art of Node
• Babel
  • Babel Introduction
  • Source-to-source compiler (Wikipedia)
• ES6/ES2015
  • Learn ES2015
  • JavaScript — Just another introduction to ES6

Dev Dependencies

• babel-cli: Babel command line.
• babel-preset-es2015: Babel preset for all es2015 plugins.
• babel-preset-react: Babel preset for all React plugins.
• babel-preset-stage-0: Babel preset for stage 0 plugins

License

MIT