oceanprotocol/commons
1
0
Fork 0
mirror of https://github.com/oceanprotocol/commons.git synced 2023-03-15 18:03:00 +01:00
Code Releases Activity

update docs

Browse Source
This commit is contained in:
Matthias Kretschmann 2019-10-14 11:04:22 +02:00
parent 74cb19f5ef
commit 59ede97931
Signed by: m
GPG Key ID: 606EEEF3C479A91F
3 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.travis.yml
View File

@ -28,9 +28,9 @@ env:
- REACT_APP_BRIZO_ADDRESS="0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0" - REACT_APP_BRIZO_ADDRESS="0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0"
# IPFS client & server config # IPFS client & server config
- REACT_APP_IPFS_GATEWAY_URI="https://ipfs.oceanprotocol.com" - REACT_APP_IPFS_GATEWAY_URI="https://ipfs.dev-ocean.com"
- REACT_APP_IPFS_NODE_URI="https://ipfs.oceanprotocol.com:443" - REACT_APP_IPFS_NODE_URI="https://ipfs.dev-ocean.com:443"
- IPFS_GATEWAY_URI="https://ipfs.oceanprotocol.com" - IPFS_GATEWAY_URI="https://ipfs.dev-ocean.com"
# start Barge with these versions # start Barge with these versions
- BRIZO_VERSION=v0.4.4 - BRIZO_VERSION=v0.4.4

9
README.md
View File

@ -31,6 +31,7 @@ If you're a developer and want to contribute to, or want to utilize this marketp
- [Client](#client) - [Client](#client)
- [Server](#server) - [Server](#server)
- [Feature Switches](#feature-switches) - [Feature Switches](#feature-switches)
- [More Settings](#more-settings)
- [👩‍🔬 Testing](#-testing) - [👩‍🔬 Testing](#-testing)
- [Unit Tests](#unit-tests) - [Unit Tests](#unit-tests)
- [End-to-End Integration Tests](#end-to-end-integration-tests) - [End-to-End Integration Tests](#end-to-end-integration-tests)
@ -144,6 +145,14 @@ Beside configuring the network endpopints, the client allows to activate some fe
| `REACT_APP_SHOW_REQUEST_TOKENS_BUTTON` | Shows a second button on the `/faucet` route to request Ocean Tokens in addition to Ether. Will only work in Ocean testnets. | | `REACT_APP_SHOW_REQUEST_TOKENS_BUTTON` | Shows a second button on the `/faucet` route to request Ocean Tokens in addition to Ether. Will only work in Ocean testnets. |
| `REACT_APP_ALLOW_PRICING` | Activate pricing feature. Will show a price input during publish flow, and output prices for each data asset. | | `REACT_APP_ALLOW_PRICING` | Activate pricing feature. Will show a price input during publish flow, and output prices for each data asset. |
#### More Settings
| Env Variable | Example | Feature Description |
| --------------------------------------------------------------------- | -------------------------------------- | ------------------------------------------------- |
| client: `REACT_APP_IPFS_GATEWAY_URI`<br /> server: `IPFS_GATEWAY_URI` | `"https://ipfs.oceanprotocol.com"` | The IPFS gateway URI. |
| `REACT_APP_IPFS_NODE_URI` | `"https://ipfs.oceanprotocol.com:443"` | The IPFS node URI used to add files to IPFS. |
| `REACT_APP_REPORT_EMAIL` | `"jelly@mcjellyfish.com"` | The email used for the _report an asset_ feature. |
## 👩‍🔬 Testing ## 👩‍🔬 Testing
Test suite is setup with [Jest](https://jestjs.io) and [react-testing-library](https://github.com/kentcdodds/react-testing-library) for unit testing, and [Cypress](https://www.cypress.io) for integration testing. Test suite is setup with [Jest](https://jestjs.io) and [react-testing-library](https://github.com/kentcdodds/react-testing-library) for unit testing, and [Cypress](https://www.cypress.io) for integration testing.

4
client/.env.local.example
View File

@ -59,5 +59,5 @@ REACT_APP_REPORT_EMAIL="test@example.com"
# REACT_APP_SHOW_CHANNELS=true # REACT_APP_SHOW_CHANNELS=true
# REACT_APP_ALLOW_PRICING=true # REACT_APP_ALLOW_PRICING=true
# REACT_APP_SHOW_REQUEST_TOKENS_BUTTON=true # REACT_APP_SHOW_REQUEST_TOKENS_BUTTON=true
# REACT_APP_IPFS_GATEWAY_URI="https://ipfs.oceanprotocol.com" REACT_APP_IPFS_GATEWAY_URI="https://ipfs.oceanprotocol.com"
# REACT_APP_IPFS_NODE_URI="https://ipfs.oceanprotocol.com:443" REACT_APP_IPFS_NODE_URI="https://ipfs.oceanprotocol.com:443"