# pleapps-collection-agent

> Plenteum App Services: Collection Agent

Latest version **0.1.0** (published 2019-02-16) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install pleapps-collection-agent
pnpm add pleapps-collection-agent
yarn add pleapps-collection-agent
bun add pleapps-collection-agent
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-02-16 |
| First published | 2019-02-16 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 68.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | The TurtlePay Developers, The Plenteum Developers |
| Maintainers | plenteum |
| Keywords | Plenteum App Services |

## Links

- npm: https://www.npmjs.com/package/pleapps-collection-agent
- Repository: https://github.com/plenteum-app-services/collection-agent
- Homepage: https://github.com/plenteum-app-services/collection-agent#readme
- Issues: https://github.com/plenteum-app-services/collection-agent/issues
- npm.io page: https://npm.io/package/pleapps-collection-agent

## Dependencies (3)

- [mysql](https://npm.io/package/mysql.md) ^2.16.0
- [big-integer](https://npm.io/package/big-integer.md) ^1.6.36
- [plenteum-rpc](https://npm.io/package/plenteum-rpc.md) ^0.3.0

## Recent versions

- 0.1.0 (latest) — 2019-02-16

## README

# Plenteum App Services Blockchain Data Collection Agent (BDCA)

#### Master Build Status
[![Build Status](https://travis-ci.org/plenteum-app-services/collection-agent.svg?branch=master)](https://travis-ci.org/plenteum-app-services/collection-agent) 
[![Build status](https://ci.appveyor.com/api/projects/status/github/plenteum-app-services/collection-agent?branch=master&svg=true)](https://ci.appveyor.com/project/plenteum-app-services/collection-agent/branch/master)

## Prerequisites

* [Plenteum](https://github.com/plenteum/plenteum)
* MariaDB/MySQL with InnoDB support
* [Node.js](https://nodejs.org/) LTS

## 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:

```bash
git clone https://github.com/plenteum-app-services/collection-agent
```

2) Install the required Node.js modules

```bash
cd collection-agent && npm install
```

3) 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

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

4) Load the database schema from `schema.sql` into your configured database.

5) Fire up the script

```bash
node index.js
```

6) Optionally, install PM2 or another process manager to keep the service running.

```bash
npm install -g pm2@latest
pm2 startup
pm2 start index.js --name blockchain-data-collection-agent
pm2 save
```

6) Wait to build your database cache (this is likely to take some time)

###### (c) 2018-2019 TurtlePay™ Development Team
###### (c) 2019 Plenteum Development Team

---
_Source: https://npm.io/package/pleapps-collection-agent · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
