dap-ps
/
discover
mirror of https://github.com/dap-ps/discover.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updates readme

This commit is contained in:
andytudhope 2019-08-08 16:34:59 +02:00
parent 069595fbcd
commit 19608fadc5
1 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -4,7 +4,7 @@ Discover new and useful DApps that are mobile-friendly and easy to use. Viewing
## Available Scripts
This project is based on Embark v4.0.1, with a few things customised for React. Currently, you'll need to run the app and Embark separately, in different tabs in your terminal.
This project is based on Embark v4.0.1, with a few things customised for React.
```
yarn run build:dev
@ -16,48 +16,47 @@ yarn run build:prod
Builds the app into the `full-build` directory and creates the `app.zip` ready for use with ElasticBeanstalk.
## Running and building the app
## Deployed Contracts
### Step 1 Build the contracts and the embark artifacts
#### Step 1.1 Understand contracts.js
Check the `config/contracts.js` file in order to check you're working with the correct contract instance. The contracts on Ropsten point at these adresses (the first is `STT`, the Status Test Token):
Ropsten (the first is `STT`, the Status Test Token):
```
MiniMeToken: { address: '0xc55cf4b03948d7ebc8b9e8bad92643703811d162' },
Discover: { address: '0x008db8b84547982e8F6677D38e9b9ea64F3ccB8B' },
```
On mainnet they are:
Mainnet:
```
MiniMeToken: { address: '0x744d70fdbe2ba4cf95131626614a1763df805b9e' },
Discover: { address: '0x5bCF2767F86f14eDd82053bfBfd5069F68C2C5F8' },
```
If you need to deploy your own, you need to target your local machine when deploying.
## Running It Locally
**Tips:** Remove any existing `.embark` directory and run `embark run testnet --noserver`.
Because we need a review stage for DApps, running this application locally can be challenging. We will fix this in due course.
#### Step 1.2 Build the application and start it
#### Step 1.1 Understand The Contracts
```bash
npm run build:dev
npm run start
```
Check the `config/contracts.js` file in order to check you're working with the correct contract instance and network.
#### Step 1.2 Use Embark Locally
1. Run `./node_modules/.bin/embark build` to build locally.
2. Go to L 125 of `src/embarkArtifacts/embarkjs.js` and change `_ipfsConnection.id()` to `_ipfsConnection.version()` due to IPFS deprecating their id() endpoint.
#### Step 1.3 Build the Application
1. Run `yarn run start`
2. You may find you still having issues to get it to work as it cannot fetch data from `http://localhost:3000/metadata/all`. We will fix this in due course.
### Running unit tests
#### Running unit tests
Use `embark test`
Will compile your contracts, with hot-reloading, and let you test them locally to your heart's content.
### Step 4 - Building for deployment
Run the build procedure via `npm run build`. Once you are done, upload the app.zip into the ElasticBean instance appropriate to the environment and it should handle the rest for you.
## Running slither
#### Running slither
`slither . --exclude naming-convention --filter-paths token `