1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-22 18:00:18 +01:00
metamask-extension/README.md

61 lines
1.7 KiB
Markdown
Raw Normal View History

2016-04-15 00:12:13 +02: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-21 01:25:45 +01:00
## Development
```bash
npm install
```
2016-03-03 18:32:52 +01: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-21 01:31:44 +01:00
### In Chrome
Open `Settings` > `Extensions`.
2016-02-08 21:07:29 +01:00
Check "Developer mode".
2015-12-21 01:31:44 +01:00
At the top, click `Load Unpacked Extension`.
2016-02-08 21:07:29 +01:00
Navigate to your `metamask-plugin/dist` folder.
2015-12-21 01:31:44 +01: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 10:21:07 +01:00
5. Next time you `gulp dev` it will watch the dependency for changes as well!
2016-03-22 18:43:56 +01:00
### Running Tests
Requires `mocha` installed. Run `npm install -g mocha`.
2016-04-18 20:41:29 +02:00
Then just run `npm test`.
You can also test with a continuously watching process, via `npm run watch`.
### Deploying the UI
2016-03-22 18:43:56 +01: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.