Go to file
Dan Finlay 761498cdbf Add vlad icons to image folder 2016-06-14 12:43:30 -07:00
app Add vlad icons to image folder 2016-06-14 12:43:30 -07:00
docs Add architecture diagram to readme 2016-06-13 16:53:21 -07:00
test Cache identicons 2016-06-06 14:05:13 -07:00
ui Size export confirmation input 2016-06-12 13:36:34 -04:00
.babelrc Added basic es6 mocha test suite 2016-03-24 17:51:46 -07:00
.editorconfig init commit 2015-07-31 18:38:02 -07:00
.gitattributes init commit 2015-07-31 18:38:02 -07:00
.gitignore Add vlad icons to image folder 2016-06-14 12:43:30 -07:00
.jshintrc init commit 2015-07-31 18:38:02 -07:00
.travis.yml Remove extraneous build target 2016-04-14 14:55:41 -07:00
.yo-rc.json init commit 2015-07-31 18:38:02 -07:00
CHANGELOG.md Write to CHANGELOG 2016-06-12 13:38:16 -04:00
README.md Add architecture diagram to readme 2016-06-13 16:53:21 -07:00
gulpfile.js ui - redesign - app header + accounts selection 2016-05-10 16:52:07 -07:00
package.json Blockchain status now updates on availability change 2016-06-03 15:18:20 -07:00
svg-notifications.md Update svg-notifications.md 2016-06-04 12:32:54 -07:00

README.md

Metamask Plugin Build Status

Architecture

Architecture Diagram

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:

  1. Clone the dependency locally.
  2. npm install in its folder.
  3. Run npm link in its folder.
  4. Run npm link $DEP_NAME in this project folder.
  5. 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.

  1. Update the version in app/manifest.json and the Changelog in CHANGELOG.md.
  2. Visit the chrome developer dashboard.
  3. Zip the dist folder in this repository.
  4. Upload that zip file as the updated package.