pleapps-collection-agent

Plenteum App Services: Collection Agent

Usage no npm install needed!

<script type="module">
  import pleappsCollectionAgent from 'https://cdn.skypack.dev/pleapps-collection-agent';
</script>

README

Plenteum App Services Blockchain Data Collection Agent (BDCA)

Master Build Status

Build Status Build status

Prerequisites

Foreword

We know that this documentation needs to be updated. We'll compile it as part of the full documentation as the project progresses.

Setup

  1. Clone this repository to wherever you'd like the API to run:
git clone https://github.com/plenteum-app-services/collection-agent
  1. Install the required Node.js modules
cd collection-agent && npm install
  1. Use your favorite text editor to change the values as necessary in config.json

Note: Make sure you use a limited database user for security reasons

{
  "mysql": {
    "host": "localhost",
    "port": 3306,
    "username": "root",
    "password": "password",
    "database": "plenteum",
    "connectionLimit": 10
  },
  "node": {
    "host": "localhost",
    "port": 44016
  }
}

  1. Load the database schema from schema.sql into your configured database.

  2. Fire up the script

node index.js
  1. Optionally, install PM2 or another process manager to keep the service running.
npm install -g pm2@latest
pm2 startup
pm2 start index.js --name blockchain-data-collection-agent
pm2 save
  1. Wait to build your database cache (this is likely to take some time)
(c) 2018-2019 TurtlePay™ Development Team
(c) 2019 Plenteum Development Team