zcash-grant-system/frontend
Will O'Beirne a37fb152b4
Rebuild contract if missing. Simplify some logic.
2018-11-27 13:21:54 -05:00
..
.storybook Integrate Storybook (#98) 2018-09-25 15:02:29 -04:00
bin Rebuild contract if missing. Simplify some logic. 2018-11-27 13:21:54 -05:00
client Merge upstream changes. 2018-11-26 20:29:33 -05:00
config Only Runtime Contracts (#225) 2018-11-25 22:02:35 -06:00
logs Replace nextjs (#54) 2018-09-17 15:55:49 -05:00
server Sentry Integration (#221) 2018-11-21 23:45:29 -06:00
stories Merge in latest changes. 2018-11-26 20:14:00 -05:00
types Merge upstream changes. 2018-11-26 20:29:33 -05:00
.envexample Only Runtime Contracts (#225) 2018-11-25 22:02:35 -06:00
.gitignore Ignore vscode files. 2018-09-14 10:54:52 -04:00
.nowignore Add nowignore (#204) 2018-11-13 12:47:33 -05:00
.npmignore Fix Zeit Deployments (#81) 2018-09-19 20:45:51 -05:00
.npmrc initial commit 2018-09-10 11:55:26 -05:00
.nvmrc Contract Build Improvements (#215) 2018-11-21 17:24:33 -06:00
.prettierrc initial commit 2018-09-10 11:55:26 -05:00
Procfile Contract Build Improvements (#215) 2018-11-21 17:24:33 -06:00
README.md initial commit 2018-09-10 11:55:26 -05:00
now.json Fix Zeit Deployments (#81) 2018-09-19 20:45:51 -05:00
package.json Merge develop in. 2018-11-26 18:47:24 -05:00
truffle.js initial commit 2018-09-10 11:55:26 -05:00
tsconfig.json Strict Typescript (pt. 1) (#150) 2018-10-19 18:03:37 -04:00
tslint.json Replace nextjs (#54) 2018-09-17 15:55:49 -05:00
yarn.lock Merge develop in. 2018-11-26 18:47:24 -05:00

README.md

Grant.io Front-End

This is the front-end component of Grant.io.

Development

  1. Install local project dependencies, and also install Truffle & Ganache globally:

    # Local dependencies
    yarn
    # Global dependencies
    yarn global add truffle ganache-cli
    
  2. (In a separate terminal) Run the ganache development blockchain:

    yarn run ganache
    
  3. Ensure you have grant-contract cloned locally and setup.

  4. (In a separate terminal) Initialize truffle, open up the repl (Changes to smart contracts will require you to re-run this):

    yarn run truffle
    
  5. Run the next.js server / webpack build for the front-end:

    yarn run dev
    
  6. Go to the dapp on localhost:3000. You'll need to setup metamask to connect to the ganache network. You'll want to add a custom "RPC" network, and point it towards localhost:8545.

Testing

Application

TBD

Smart Contract

Truffle can run tests written in Solidity or JavaScript against your smart contracts. Note the command varies slightly if you're in or outside of the development console.

# If inside the truffle console
test

# If outside the truffle console
truffle test