mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 09:52:26 +01:00
🦊 Minimalized version of MetaMask for my own personal use.
c9dfc62123
* Stylelint: Ignore only top-level directories The `.stylelintignore` entries lacked leading slashes, so most of the UI code was ignored (because it fell under the `ui/app` directory, and `app/` was ignored. The leading slashes ensure only the intended top-level directories are ignored. * Simplify stylelint rules We use the `stylelint-config-standard` rule-set, so most commonly-used stylelint rules are inherited from that. Some of the removed rules were redundant, some of them were more strict than the rules in `standard` and we hadn't been following them in practice, and some were obsolete. * Convert stylelint config to JavaScript JavaScript is a bit easier than JSON to work with, as it allows comments. This was also done to make it easier to merge in the `stylelint-config- standard`, which is also in JavaScript. * Inline `stylelint-config-standard` I intend to go through each of these rules one-by-one, which is easier with all of these rules inlined. Selectively overriding/disabling them would have been messy. * Comment out rules that aren't current working These rules have been temporarily disabled. They will be re-renabled one-by-one as they are fixed. This was done to make it easier to split these changes among separate PRs, as many of the rules require extensive functional changes. * Add `stylelint` to `lint` script `stylelint` is now run as part of the `lint` script. There is also a separate `lint:styles` script for running just `stylelint`. |
||
---|---|---|
.circleci | ||
.github | ||
.storybook | ||
app | ||
development | ||
docs | ||
test | ||
ui | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.js | ||
.gitattributes | ||
.gitignore | ||
.nvmrc | ||
.stylelintignore | ||
babel.config.js | ||
CHANGELOG.md | ||
LICENSE | ||
MISSION.md | ||
nyc.config.js | ||
package.json | ||
README.md | ||
stylelint.config.js | ||
USER_AGREEMENT.md | ||
yarn.lock |
MetaMask Browser Extension
You can find the latest version of MetaMask on our official website. For help using MetaMask, visit our User Support Site.
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
- 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