Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 5.6 KB

README.md

File metadata and controls

101 lines (68 loc) · 5.6 KB

Home page: ribbon-app-ten.vercel.app

Staging: ribbon-app-ten.vercel.app/

Production: ribbon-app-ten.vercel.app/

license code style: prettier Contributions welcome

Ribbon Protocol is a universal health coverage rewards and loyalty platform that aims to modify health and wellness behavior through incentivization and rewardable tasks.

The Ribbon App intertwines Universal Basic Income with Universal Health Coverage, utilizing World ID users health & socioeconomic data to enhance global well-being. The protocol rewards users for activities that help assess their wellness and socioeconomic needs, while linking them to equitable UBI and personalized services.

Rewards and Incentives are distributed in points and WLD tokens, on the Optimism Mainnet network which is a Layer 2 network of the Ethereum blockchain.

Table of Contents

Packages

This RibbonProtocol App contains JavaScript tools and applications that enables users to earn tokenized universal basic income. The ribbon app consists of three key components right now; this will change in time. These are as follows:

Name Description
@ribbonprotocol/api Backend API built with Typescript and NestJS restful API that handles data capture for users and all system wide interactions.
@ribbonprotoccol/frontend Frontend NextJS application that users interact with. Link
@ribbonprotoccol/admin-panel Frontend NextJS application for admin management.

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

Requirements

This project requires node >=18.0.0, npm >=10.x.x and pnpm >=8.x.x. A unix shell is also required.

Getting Started

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

git clone https://github.com/RibbonBlockchain/RibbonApp.git
cd RibbonApp
pnpm install

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

pnpm run dev

Open http://localhost:3000 with your browser to see the result.

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 pnpm or npm. The main things you can do are outlined below:

    pnpm dev       # start the development server/environment
    pnpm build     # run a production build
    pnpm start     # starts the application in a production-like environment
    pnpm lint      # runs a linter on your codebase

Deployment

RibbonProtocol App is currently deployed using vercel.

Contributing

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

Read the "Contributing to RibbonProtocol App" 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 RibbonProtocol is about, be sure to take a look at these other resources

  1. Website
  2. Twitter
  3. Telegram Announcements
  4. Telegram Community Group
  5. Discord
  6. Blog
  7. Instagram
  8. Facebook
  9. YouTube
  10. TikTok
  11. LinkedIn