mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00

Mark Stacey 9ed64568f4 Update to Node.js v10

The only package that needed to be updated was `sha3`. It has been
updated to v1.2.3, which is a maintenance release that supports up to
Node.js v12.

2019-06-27 11:46:13 -03:00

MetaMask Browser Extension

You can find the latest version of MetaMask on our official website. For help using MetaMask, visit our User Support Site.

For up to the minute news, follow our Twitter or Medium pages.

To learn how to develop MetaMask-compatible applications, visit our Developer Docs.

To learn how to contribute to the MetaMask project itself, visit our Internal Docs.

Building locally

Install Node.js version 10 and the latest available npm@6
- If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
- If you install Node.js manually, ensure you're using npm@6
  - Install npm@6 using npm install -g npm@6
Install dependencies: npm ci
- If you have issues with node-sass compilation, try npm rebuild node-sass
Build the project to the ./dist/ folder with npm run dist.
Optionally, to start a development build (e.g. with logging and file watching) run npm start instead.

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

You can re-generate the docs locally by running npm run doc, and contributors can update the hosted docs by running npm run publish-docs.

Run tests with npm test.

You can also test with a continuously watching process, via npm run watch.

You can run the linter by itself with npm run lint.

npm install
npm start

npm run dist

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