nifty-wallet/README.md

68 lines
2.1 KiB
Markdown
Raw Normal View History

2016-04-14 15:12:13 -07:00
# Metamask Plugin [![Build Status](https://travis-ci.com/MetaMask/metamask-plugin.svg?token=3txzDGFpqQqvRCdgwTJp&branch=master)](https://travis-ci.com/MetaMask/metamask-plugin)
2015-12-20 16:25:45 -08:00
## Development
```bash
npm install
```
2016-03-03 09:32:52 -08:00
### 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:
```bash
npm install gulpjs/gulp-cli#4.0 -g
```
After that, you can just:
```bash
gulp dev
```
2015-12-20 16:31:44 -08:00
### In Chrome
Open `Settings` > `Extensions`.
2016-02-08 12:07:29 -08:00
Check "Developer mode".
2015-12-20 16:31:44 -08:00
At the top, click `Load Unpacked Extension`.
2016-02-08 12:07:29 -08:00
Navigate to your `metamask-plugin/dist` folder.
2015-12-20 16:31:44 -08:00
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.
2016-03-14 02:21:07 -07:00
5. Next time you `gulp dev` it will watch the dependency for changes as well!
2016-03-22 10:43:56 -07:00
### Running Tests
Currently the tests are split between two suites (we recently merged the UI into the main plugin repository). There are two different test suites to be concerned with:
Plugin tests, `npm test`.
UI tests, `npm run testUi`.
You can also run both of these with continuously watching processes, via `npm run watch` and `npm run watchUi`.
#### UI Testing Particulars
Requires `mocha` installed. Run `npm install -g mocha`.
You can either run the test suite once with `npm testUi`, or you can reload on file changes, by running `mocha watch ui/test/**/**`.
### Deploying the UI
2016-03-22 10:43:56 -07:00
You must be authorized already on the Metamask plugin.
0. Update the version in `app/manifest.json` and the Changelog in `CHANGELOG.md`.
1. Visit [the chrome developer dashboard](https://chrome.google.com/webstore/developer/dashboard?authuser=2).
2. Zip the `dist` folder in this repository.
3. Upload that zip file as the updated package.