feathers-giveth

Real-time json cache server for blockchain data

Welcome to the server code for Giveth's dapp. The dapp uses feathers as a cache for its blockchain transactions. By utilizing websockets on both the blockchain and client devices, we can receive and push updates simultaneously to all users in real time.

Table of content

• Getting Started
  • Install
  • Run server
• Deploying
• Scripts
• Testing
• Usage
• Help

Getting Started

Install

1. Click Star on this repo near the top-right corner of this web page.
2. Join our slack if you haven't already.
3. Fork this repo by clicking Fork button in top-right corner of this web page. Continue to follow instruction steps from your own feathers-giveth repo.
4. The rest of these steps must be done from your machine's command line. Clone your own "feathers-giveth" repo:

   git clone https://github.com/GITHUB_USERNAME/feathers-giveth.git
   

5. Change directories to feathers-giveth:

   cd feathers-giveth
   

6. Make sure you have NodeJS (v8.4.0 or higher), yarn (v0.27.5 or higher), and npm (5.4.1 or higher) installed.
7. Install dependencies from within feathers-giveth directory:

   npm install
   

   • note: due to a bug in yarn, yarn install currently does not work

Run server

The feathers server will need to connect to an ethereum node via websockets. Typically this will be a local TestRPC instance. The configuration param blockchain.nodeUrl is used to establish a connection. The default nodeUrl is ws://localhost:8546

1. We provide an easy way to start a TestRPC instance.

   yarn testrpc
   

2. Since TestRPC is now running, open a new terminal window and navigate to the same feathers-giveth directory.

3. The TestRPC instance simulates a new blockchain. So we must deploy any contracts we intend to call.

   node --harmony scripts/deploy.js
   

4. Start your app

   yarn start
   

Deploying

1. Start a production server

   yarn serve
   

Scripts

The feathers-giveth/scripts directory contains a few scripts to help development.

deploy.js - deploys a new vault & liquidPledging contract

getState.js - prints the current state of the deployed vault & liquidPledging contracts.

confirm.js - confirms any payments that are pending in the vault

Testing

Simply run yarn test and all your tests in the test/ directory will be run.

Usage

Each of these services are available via rest or websockets:

campaigns
dacs
donations
donationsHistory
milestones
uploads
users

If the server is using default configurations, you can see data for any of these services through your web browser at http://localhost:3030/SERVICE_NAME

Help

For more info on how to work with feathers checkout out their docs on service methods, service events, and database querying.

Also feel free to reach out to us on slack for any help or to share ideas.