Jakub Sokołowski
f4dd909c15
Signed-off-by: Jakub Sokołowski <jakub@status.im> |
||
---|---|---|
back-end | ||
config | ||
contracts | ||
public | ||
src | ||
test | ||
utils | ||
.editorconfig | ||
.eslintrc.json | ||
.gitattributes | ||
.gitignore | ||
.npmrc | ||
.prettierrc | ||
.soliumignore | ||
.soliumrc.json | ||
Discover_Specification.md | ||
LICENSE | ||
README.md | ||
build.sh | ||
embark.json | ||
package.json | ||
shared.testnet.chains.json | ||
yarn.lock |
README.md
Discover
Discover new and useful DApps that are mobile-friendly and easy to use. Viewing curated information does not require any special tools, though effecting the way information is ranked will require a web3 wallet, whether that is Status, MetaMask, Trust, Brave or whichever one you prefer.
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.
npm run build
Builds the app into the build
directory.
Running and building the app
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):
MiniMeToken: { address: '0xc55cf4b03948d7ebc8b9e8bad92643703811d162' },
Discover: { address: '0x9fb115BC152aE21ECDc81c73843673fa38e4D2dB' },
On mainnet they are:
MiniMeToken: { address: '0x744d70fdbe2ba4cf95131626614a1763df805b9e' },
Discover: { address: 'TBA' },
If you need to deploy your own, you simply need to target your local machine when deploying.
Tips: Remove any existing .embark
directory and run embark run testnet --noserver
. Use this etherscan address to check the address of the contract you last deployed.
https://ropsten.etherscan.io/address/0x65767f95799109ba028e0397add89b0ef637e444
Step 1.2 Generate the embark contract artifacts
Run embark build
in order to generate src/embarkArtifacts/
.
Observe that you find near the beginning of the Discover.js and MiniMeToken.js files the addresses you supplied in Step 1.1
Step 1.3 Fix embark configuration
In embarkjs.js line 125. If you find this._ipfsConnection.id()
-> change it to this._ipfsConnection.version()
This is needed because Infura's IPFS has deprecated id
endpoint, but this is only updated in Embark 4.1.
Step 2. Run the client side app localy.
Run the client side application via npm run start
.
Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.
Important! If you get can't establish a connection to a node
error, try to open http://localhost:3000 in Chrome.
Step 3 - Run the 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, copy the contents of the build directory, in the frontend
directory in the branch called app-deployment
.
Deployments Steps AWS
-
Run
. build.sh
, and zip the resultingfull-build
folder. Use. build.sh --dev
when building for our dev environment. -
Click Upload and deploy button in the middle of the screen.
-
Choose the .zip file containing the code
-
Change the version if want to keep some exact numbering
-
Click Deploy
Changing .env variables in AWS
If you've changed some smart contracts you need to change their addresses in the env variables.
- Go to AWS Configuration and on Software section click Modify
- Scroll down and find Environment Properties
- Change whatever property needs changing
- Click Apply at the bottom right
Running slither
slither . --exclude naming-convention --filter-paths token
Make sure you get TrailofBits' latest static analysis tool, and do your own static analysis on the relevant contracts that will be deployed for Discover.