1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
metamask-extension/README.md
2018-07-27 09:34:03 -07:00

5.8 KiB

MetaMask Browser Extension

Build Status Coverage Status Greenkeeper badge Stories in Ready

Support

If you're a user seeking support, here is our support site.

Introduction

Mission Statement

Internal documentation

Developing Compatible Dapps

If you're a web dapp developer, we've got two types of guides for you:

New Dapp Developers

Current Dapp Developers

Building locally

  • Install Node.js version 8.11.3 and npm version 6.1.0
  • Install dependencies:
    • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
  • Install gulp globally with npm install -g gulp-cli.
  • Build the project to the ./dist/ folder with gulp build.
  • Optionally, to rebuild on file changes, run gulp dev.
  • To package .zip files for distribution, run gulp zip, or run the full build & zip with gulp dist.

Uncompressed builds can be found in /dist, compressed builds can be found in /builds once they're built.

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.

You can run the linter by itself with gulp lint.

Architecture

Architecture Diagram

Development

npm install
npm start

Build for Publishing

npm run dist

Writing Browser Tests

To write tests that will be run in the browser using QUnit, add your test files to test/integration/lib.

Other Docs