-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
This reverts commit 403e63c.
- Loading branch information
Bruno Barbieri
authored
Feb 19, 2019
1 parent
403e63c
commit ebd8a4f
Showing
1 changed file
with
9 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,62 +1,22 @@ | ||
![MetaMask logo](logo.png?raw=true) | ||
# MetaMask | ||
MetaMask is a mobile web browser that provides easy access to websites that use the [Ethereum](https://ethereum.org/) blockchain. | ||
|
||
For up to the minute news, follow our [Twitter](https://twitter.com/metamask_io) or [Medium](https://medium.com/metamask) pages. | ||
|
||
To learn how to develop MetaMask-compatible applications, visit our [Developer Docs](https://metamask.github.io/metamask-docs/). | ||
|
||
## MetaMask Mobile | ||
|
||
### Building locally | ||
The code is built using React-Native and running code locally requires a Mac or Linux OS. | ||
|
||
- Install [Node.js](https://nodejs.org) **version 8 (latest stable) and npm@6** | ||
- If you are using [nvm](https://github.com/creationix/nvm#installation) (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` | ||
|
||
- Before starting, you need to install React Native dependencies: | ||
- [MacOs](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies-1) | ||
- [Linux](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies-2) | ||
- Now clone this repo and then install all our dependencies | ||
|
||
```bash | ||
cd MetaMask | ||
npm i | ||
``` | ||
MetaMask is a mobile web browser that provides easy access to websites that use the [Ethereum](https://ethereum.org/) blockchain. | ||
|
||
- Running the app on Android: | ||
[http://metamask.io/](http://metamask.io/) | ||
|
||
```bash | ||
npm run start:android | ||
``` | ||
[![CircleCI](https://circleci.com/gh/MetaMask/MetaMask.svg?style=shield)](https://circleci.com/gh/MetaMask/MetaMask) | ||
[![codecov](https://codecov.io/gh/bitpshr/MetaMask/branch/master/graph/badge.svg)](https://codecov.io/gh/bitpshr/MetaMask) | ||
|
||
- Running the app on iOS: | ||
## Development | ||
|
||
```bash | ||
npm run start:ios | ||
``` | ||
The following instructions assume that the React Native [Getting Started](https://facebook.github.io/react-native/docs/getting-started.html) guide for your platform has been completed. | ||
|
||
### Running tests: | ||
- Unit test: | ||
``` | ||
npm run test:unit | ||
``` | ||
- E2E Tests (iOS) | ||
``` | ||
npm run test:e2e:ios | ||
``` | ||
- E2E Tests (Android) | ||
$ npm i | ||
$ react-native run-ios | ||
``` | ||
npm run test:e2e:android | ||
``` | ||
|
||
|
||
### Troubleshooting | ||
|
||
Visit [Troubleshooting for React Native](https://facebook.github.io/react-native/docs/troubleshooting#content) | ||
|
||
## License | ||
|
||
TBD | ||
[MIT](./LICENSE) |