feat: update documentation

This commit is contained in:
Richard Ramos 2019-10-21 08:55:20 -04:00
parent 918b457ffe
commit 7bf22ebb2c
8 changed files with 102 additions and 16 deletions

View File

@ -1,14 +1,17 @@
subspace - react example
===
Simple application using a react observable component to receive a stream of emitted events. This app will deploy a test contract to **Ganache**.
Simple application using a react observable component to receive a stream of emitted events. This app will deploy a test contract to **Ganache**. This example assumes you have Embark installed
## Requirements
- `embark` framework installed. https://embark.status.im
- `ganache-cli`
- `yarn` or `npm` installed.
## Install
In the parent folder, link the package with `yarn` or `npm`
In the parent folder, install, build and link the package with `yarn` or `npm`
```
yarn
yarn build:dev
yarn link
```
Then in the current folder link `subspace`, and install the packages

View File

@ -7,8 +7,10 @@ Simple application using Apollo to receive a stream of emitted events. This app
- `yarn` or `npm` installed.
## Install
In the parent folder, link the package with `yarn` or `npm`
In the parent folder, install, build and link the package with `yarn` or `npm`
```
yarn
yarn build:dev
yarn link
```
Then in the current folder link `@status-im/subspace`, and install the packages
@ -31,4 +33,14 @@ yarn run start
Browse the DApp in [http://localhost:3000](http://localhost:3000)
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
### node-gyp problems
node-gyp can cause problems, because it requires a C++ compiler.
If you do have problems caused by it, first follow the installation steps for your OS [here](https://github.com/nodejs/node-gyp#installation).
If you still have problems and are on Windows, try the following:
- run `npm config set msvs_version 2015` before `npm install`
- Repair Windows Build tools that the node-gyp doc made you install. If it tells you to remove a conflicting version do it. After the repair succeeded, reboot.

View File

@ -7,8 +7,10 @@ Simple application using a react observable component to receive a stream of emi
- `yarn` or `npm` installed.
## Install
In the parent folder, link the package with `yarn` or `npm`
In the parent folder, install, build and link the package with `yarn` or `npm`
```
yarn
yarn build:dev
yarn link
```
Then in the current folder link `@status-im/subspace`, and install the packages
@ -38,4 +40,14 @@ yarn run start
Browse the DApp in [http://localhost:3000](http://localhost:3000)
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
### node-gyp problems
node-gyp can cause problems, because it requires a C++ compiler.
If you do have problems caused by it, first follow the installation steps for your OS [here](https://github.com/nodejs/node-gyp#installation).
If you still have problems and are on Windows, try the following:
- run `npm config set msvs_version 2015` before `npm install`
- Repair Windows Build tools that the node-gyp doc made you install. If it tells you to remove a conflicting version do it. After the repair succeeded, reboot.

View File

@ -7,8 +7,10 @@ Simple application that dispatches a redux action whenever an event is emitted.
- `yarn` or `npm` installed.
## Install
In the parent folder, link the package with `yarn` or `npm`
In the parent folder, install, build and link the package with `yarn` or `npm`
```
yarn
yarn build:dev
yarn link
```
Then in the current folder link `@status-im/subspace`, and install the packages
@ -31,4 +33,14 @@ yarn run start
Browse the DApp in [http://localhost:3000](http://localhost:3000)
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
### node-gyp problems
node-gyp can cause problems, because it requires a C++ compiler.
If you do have problems caused by it, first follow the installation steps for your OS [here](https://github.com/nodejs/node-gyp#installation).
If you still have problems and are on Windows, try the following:
- run `npm config set msvs_version 2015` before `npm install`
- Repair Windows Build tools that the node-gyp doc made you install. If it tells you to remove a conflicting version do it. After the repair succeeded, reboot.

View File

@ -7,8 +7,10 @@ Simple application using a react observable component to receive a stream of emi
- `yarn` or `npm` installed.
## Install
In the parent folder, link the package with `yarn` or `npm`
In the parent folder, install, build and link the package with `yarn` or `npm`
```
yarn
yarn build:dev
yarn link
```
Then in the current folder link `@status-im/subspace`, and install the packages
@ -31,4 +33,13 @@ yarn run start
Browse the DApp in [http://localhost:3000](http://localhost:3000)
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
### node-gyp problems
node-gyp can cause problems, because it requires a C++ compiler.
If you do have problems caused by it, first follow the installation steps for your OS [here](https://github.com/nodejs/node-gyp#installation).
If you still have problems and are on Windows, try the following:
- run `npm config set msvs_version 2015` before `npm install`
- Repair Windows Build tools that the node-gyp doc made you install. If it tells you to remove a conflicting version do it. After the repair succeeded, reboot.

View File

@ -7,8 +7,10 @@ Simple application that shows how to use graphql queries with Subspace observabl
- `yarn` or `npm` installed.
## Install
In the parent folder, link the package with `yarn` or `npm`
In the parent folder, install, build and link the package with `yarn` or `npm`
```
yarn
yarn build:dev
yarn link
```
Then in the current folder link `@status-im/subspace`, and install the packages
@ -31,4 +33,14 @@ node src/index.js
You'll see in the console the result of the graphql query
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before executing the dapp.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before executing the dapp.
### node-gyp problems
node-gyp can cause problems, because it requires a C++ compiler.
If you do have problems caused by it, first follow the installation steps for your OS [here](https://github.com/nodejs/node-gyp#installation).
If you still have problems and are on Windows, try the following:
- run `npm config set msvs_version 2015` before `npm install`
- Repair Windows Build tools that the node-gyp doc made you install. If it tells you to remove a conflicting version do it. After the repair succeeded, reboot.

View File

@ -7,8 +7,10 @@ NodeJS application that uses `redux-observable` to initialize Subspace, deploy a
- `yarn` or `npm` installed.
## Install
In the parent folder, link the package with `yarn` or `npm`
In the parent folder, install, build and link the package with `yarn` or `npm`
```
yarn
yarn build:dev
yarn link
```
Then in the current folder link `"@status-im/subspace"`, and install the packages
@ -31,4 +33,14 @@ node -r esm src/index.js
You'll see in the console how the state changes everytime subspace receives an event, and a new transaction is created every second or so.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before browsing the dapp.
### node-gyp problems
node-gyp can cause problems, because it requires a C++ compiler.
If you do have problems caused by it, first follow the installation steps for your OS [here](https://github.com/nodejs/node-gyp#installation).
If you still have problems and are on Windows, try the following:
- run `npm config set msvs_version 2015` before `npm install`
- Repair Windows Build tools that the node-gyp doc made you install. If it tells you to remove a conflicting version do it. After the repair succeeded, reboot.

View File

@ -8,8 +8,10 @@ For using Subspace with `react` and `redux`, please check `examples/react-redux`
- `yarn` or `npm` installed.
## Install
In the parent folder, link the package with `yarn` or `npm`
In the parent folder, install, build and link the package with `yarn` or `npm`
```
yarn
yarn build:dev
yarn link
```
Then in the current folder link `@status-im/subspace`, and install the packages
@ -32,4 +34,14 @@ node -r esm src/index.js
You'll see in the console how the state changes everytime Subspace receives an event.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before executing the dapp.
*Note*: this is a simple example application that does not include error handling for the web3 connection. Be sure `ganache-cli` is running in `localhost:8545` before executing the dapp.
### node-gyp problems
node-gyp can cause problems, because it requires a C++ compiler.
If you do have problems caused by it, first follow the installation steps for your OS [here](https://github.com/nodejs/node-gyp#installation).
If you still have problems and are on Windows, try the following:
- run `npm config set msvs_version 2015` before `npm install`
- Repair Windows Build tools that the node-gyp doc made you install. If it tells you to remove a conflicting version do it. After the repair succeeded, reboot.