The changes are persisted to localstorage, so they cannot be restored on a new computer, but for right now it's a nice organizational feature. |
||
---|---|---|
app | ||
test | ||
ui | ||
.babelrc | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.jshintrc | ||
.travis.yml | ||
.yo-rc.json | ||
CHANGELOG.md | ||
README.md | ||
gulpfile.js | ||
package.json | ||
svg-notifications.md |
README.md
Metamask Plugin ![Build Status](https://travis-ci.com/MetaMask/metamask-plugin.svg?token=3txzDGFpqQqvRCdgwTJp&branch=master)
Development
npm install
Developing with Gulp
We're using an experimental version of gulp-cli
, so if you have the old version of gulp, you'll need to uninstall it, npm uninstall -g gulp
, and install this one instead:
npm install gulpjs/gulp-cli#4.0 -g
After that, you can just:
gulp dev
In Chrome
Open Settings
> Extensions
.
Check "Developer mode".
At the top, click Load Unpacked Extension
.
Navigate to your metamask-plugin/dist
folder.
Click Select
.
You now have the plugin, and can click 'inspect views: background plugin' to view its dev console.
Developing the UI
To enjoy the live-reloading that gulp dev
offers while working on the web3-provider-engine
or other dependencies:
- Clone the dependency locally.
npm install
in its folder.- Run
npm link
in its folder. - Run
npm link $DEP_NAME
in this project folder. - Next time you
gulp dev
it will watch the dependency for changes as well!
Running Tests
Requires mocha
installed. Run npm install -g mocha
.
Then just run npm test
.
You can also test with a continuously watching process, via npm run watch
.
Deploying the UI
You must be authorized already on the Metamask plugin.
- Update the version in
app/manifest.json
and the Changelog inCHANGELOG.md
. - Visit the chrome developer dashboard.
- Zip the
dist
folder in this repository. - Upload that zip file as the updated package.