Erik Marks
ef1b6a7b7e
|
4 years ago | |
---|---|---|
.circleci | 4 years ago | |
.github | 4 years ago | |
.storybook | 4 years ago | |
app | 4 years ago | |
development | 4 years ago | |
docs | 4 years ago | |
shared | 4 years ago | |
test | 4 years ago | |
ui | 4 years ago | |
.editorconfig | 6 years ago | |
.eslintrc.js | 4 years ago | |
.gitattributes | 4 years ago | |
.gitignore | 4 years ago | |
.metamaskrc.dist | 4 years ago | |
.nvmrc | 5 years ago | |
.prettierignore | 4 years ago | |
.prettierrc.yml | 4 years ago | |
CHANGELOG.md | 4 years ago | |
LICENSE | 4 years ago | |
README.md | 4 years ago | |
babel.config.js | 4 years ago | |
nyc.config.js | 5 years ago | |
package.json | 4 years ago | |
stylelint.config.js | 4 years ago | |
yarn.lock | 4 years ago |
README.md
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 general questions, feature requests, or developer questions, visit our Community Forum.
MetaMask supports Firefox, Google Chrome, and Chromium-based browsers. We recommend using the latest available browser version.
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
- If you are using nvm (recommended) running
nvm use
will automatically choose the right node version for you.
- If you are using nvm (recommended) running
- Install Yarn
- Install dependencies:
yarn
- Copy the
.metamaskrc.dist
file to.metamaskrc
- Replace the
INFURA_PROJECT_ID
value with your own personal Infura Project ID. - If debugging MetaMetrics, you'll need to add a value for
SEGMENT_WRITE_KEY
Segment write key.
- Replace the
- Build the project to the
./dist/
folder withyarn dist
. - Optionally, to start a development build (e.g. with logging and file watching) run
yarn start
instead.- To start the React DevTools and Redux DevTools Extension
alongside the app, use
yarn start:dev
.- React DevTools will open in a separate window; no browser extension is required
- Redux DevTools will need to be installed as a browser extension. Open the Redux Remote Devtools to access Redux state logs. This can be done by either right clicking within the web browser to bring up the context menu, expanding the Redux DevTools panel and clicking Open Remote DevTools OR clicking the Redux DevTools extension icon and clicking Open Remote DevTools.
- You will also need to check the "Use custom (local) server" checkbox in the Remote DevTools Settings, using the default server configuration (host
localhost
, port8000
, secure connection checkbox unchecked)
- You will also need to check the "Use custom (local) server" checkbox in the Remote DevTools Settings, using the default server configuration (host
- To start the React DevTools and Redux DevTools Extension
alongside the app, use
Uncompressed builds can be found in /dist
, compressed builds can be found in /builds
once they're built.
Contributing
Running Tests
Run tests with yarn test
.
You can also test with a continuously watching process, via yarn watch
.
You can run the linter by itself with yarn lint
.
Architecture
Development
yarn
yarn start
Build for Publishing
yarn dist