MechaMittens 🤖🧤

Helping keep hands strong.

MechaMittens is a browser extension to access Web3 on Firefox and Chromium-based browsers. It's a libre fork of MetaMask, before the project decided to abandon free and open-source software.

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.
• Install Yarn
• Install dependencies: yarn
• Build the project to the ./dist/ folder with yarn 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, port 8000, secure connection checkbox unchecked)

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

Other Docs

• How to add custom build to Chrome
• How to add custom build to Firefox
• How to add a new translation to MechaMittens
• Publishing Guide
• How to use the TREZOR emulator
• How to generate a visualization of this repository's development

Contributors ✨

We're standing on the shoulders of giants.

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Attribution 🗿

Many emojis designed by OpenMoji – the open-source emoji and icon project. License: CC BY-SA 4.0