robtg4 / tcr-ui

Client-side shell to interact with token-curated registries

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TCR UI (WIP)

FOSSA Status

Build Status

"Token-curated registries are decentrally-curated lists with intrinsic economic incentives for token holders to curate the list's contents judiciously" - Mike Goldin

TCRs use an intrinsic token to incentivize a community to curate and reach decentralized consensus on a Registry of high-quality entries


Commands / Run

Development

Run app in dev mode in browser, rebuild on file changes

  $ npm run dev

Build

Build production server app

$ npm run build

Tests

Run unit tests with Jest

  $ npm test

Local blockchain/RPC (optional)

ganache-cli - http://localhost:8545

  $ npm install -g ganache-cli
  $ ganache-cli

Deploy (optional)

Clone contracts:

  $ git clone git@github.com:kangarang/tcr.git
  $ cd tcr
  $ npm install

Build JSON ABI artifacts:

(Note: only have to run once. While ganache-cli is running)

  $ npm run install && npm run compile

Deploy contracts to local RPC:

  $ npm run deploy-ganache

Deploy contracts to Rinkeby Test Network:

  $ npm run deploy-rinkeby

Deploy contracts to Main Network:

  $ npm run deploy-mainnet

Directory structure

ducks

re-ducks

|
├── docs - Documentation
├── public - Files that don't get compiled, just moved to build
|  └── index.html - Html template file
├── src
|  ├── state - Redux
|  |  ├── ducks - Redux modules
|  |  |  ├── [duck] - Single module
|  |  |  |  ├── sagas - Asynchronous side-effects
|  |  |  |  ├── tests - Jest unit tests
|  |  |  |  ├── actions.js - Action creators / plain objects
|  |  |  |  ├── index.js - Duck root import / export
|  |  |  |  ├── reducers.js - Pure functions / immutable.js
|  |  |  |  ├── selectors.js - State selectors / reselect.js
|  |  |  |  ├── types.js - Action types / string constants
|  |  |  |  └── utils.js - Module-specific helpers
|  |  |  ├── index.js - Ducks root
|  |  |  └── reducers - Reducer combiner
|  |  ├── libs - Framework-agnostic libraries
|  |  ├── utils - Common utility helper functions
|  |  ├── store.js - Redux reducer and middleware injector
|  ├── views - React
|  |  ├── assets - Images, fonts, etc.
|  |  ├── components - Stateless, dumb components
|  |  ├── containers - Stateful, smart containers
|  |  ├── translations - Language JSON dictionaries
|  |  ├── App.js - Root React component
|  |  └── global-styles.js - Theme / colors
|  └── index.js - Entry point for app
└── server.js - Express.js app

Docs

State Changes

TCR Endpoints

InterPlanetary Shenanigans


Resources

Articles

Code

Community


Acknowledgements

Aragon-ui

0x.js

Augur

MyCrypto

UDAPP


Workflow diagrams

These workflow diagrams were created by our wonderful designer, Eva Shon

Simple overview

Detailed workflow


License

This project is licensed under the MIT license, Copyright (c) 2018 Isaac Kang. For more information see LICENSE.

About

Client-side shell to interact with token-curated registries

License:MIT License


Languages

Language:JavaScript 99.5%Language:CSS 0.3%Language:HTML 0.2%