Skip to content

JavaScript tools and applications that interact with RibbonBlockchain smart contracts

License

Notifications You must be signed in to change notification settings

RibbonBlockchain/IncentivesAlpha

Repository files navigation

API CI: CircleCI

Front End CI production: Netlify Status

Front End CI staging: Netlify Status

Home page: ribbonblockchain.com

Staging: dapp-staging.ribbonblockchain.com

Production: dapp.ribbonblockchain.com

RibbonBlockchain


license code style: prettier Commitizen friendly lerna Contributions welcome

Ribbon Blockchain is a healthcare incentives platform that aims to modify health and wellness behaviour through rewardable tasks.

Ribbon channels donated, pledged or sponsored funding directly to patients, community health workers and healthcare practitioners; where such funding is used to incentivize preventative care, adherence to medication and therapy, quality of care delivery and overall population health outcomes.

Our Incentives are distributed in DAI, an asset-backed, decentralized stablecoin on the Ethereum blockchain.

Table of Contents

Packages

This monorepo contains JavaScript tools and applications that interact with RibbonBlockchain's smart contracts. The ribbon platform consists of 3 key components right now. this will change in time. These are as follows:

Name Description
@ribbonblockchain/api Backend API built with Node, typscript express restful API that handles data capture for patients and all system wide interactions.
@ribbonblockchain/frontend Frontend react application that patients, CHW, practitioners and admins interact with. Link
@ribbonblockchain/blockchain Solidity Smart contracts that control the funding distribution, allocation and assignment within the Ribbon ecosystem.

Each section has it's own package and has it's own readme within the package that explains how to set it up and get running with that spesific component.

Requirements

This project requires node >=10.0.0 and yarn >=1.0.0. A unix shell is also required.

Getting Started

To get started, clone the repo and install its dependencies:

git clone https://github.com/RibbonBlockchain/IncentivesAlpha.git
cd IncentivesAlpha
yarn

For development purposes there's a top-level start script that will watch and continuously compile all packages concurrently:

yarn frontend:start

For next steps, take a look at documentation for the individual package(s) you want to run and/or develop. Each package can be run from the root directory using Lerna. The main things you can do are outlined below:

    yarn frontend:start         # start run the front end server
    yarn frontend:build         # build front end for production

    yarn contracts:build        # compile the smart contracts
    yarn contracts:deploy:local # deploy smart contract to local ganage instance
    yarn contracts:deploy:sokol # deploy contract to sokol test POA network
    yarn contracts:start        # start a local ganache-cli instance
    yarn contracts:test         # run contract unit tests
    yarn contracts:cover        # generate coverage report

    yarn backend:test           # run API unit tests
    yarn backend:build:         # build API for production
    yarn backend:dev            # start API in development mode
    yarn backend:prod           # start API in production mode

Contributing

Thanks for your interest in RibbonBlockchain. There are many ways you can contribute. To start, take a few minutes to look over the official guide:

Read the "Contributing to RibbonBlockchain" Guide »

We happily await your pull requests and/or involvement in our issues page and hope to see your username on our list of contributors 🎉🎉🎉

Resources

To get a full idea of what RibbonBlockchain is about, be sure to take a look at these other resources

  1. Website
  2. Alpha DApp
  3. Twitter