README.md

EOS Power Up Resource Watcher

This script is meant to be run as a cron job that checks if an account's CPU and NET resources are below a certain threshold.

If the resources are low it will call a powerup action to top off available resources for the contract.

Installation

Basic knowledge about Docker and NodeJS is required.

Getting started

Some things you need before getting started:

• git
• node.js
• docker

Running for the first time

1. Clone this repo using git clone --depth=1 https://github.com/eoscostarica/eos-resource-watcher.git <YOUR_PROJECT_NAME>
2. Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
3. Copy and rename the .env.example to .env then update the environment variables according to your needs

Quick start

At this point you can execute make run to execute the resource watcher locally.

File Structure

Within the project repository you will find the following directories and files:

eos-resource-watcher/
├── src ..................... Project Source Code
| ├── index.js .............. Resource Watcher Script
| ├── config ................ Configuration Parameters
│ └── utils ................. EOSJS Utilities
├── package.json ............ NPM Project Metadata
├── yarn-lock.json .......... NPM Packages Lock File
├── .env.example ............ Environmental Variables Example File
├── .gitignore .............. Files Ignored by Git
├── Dockerfile .............. Docker Build 
├── LICENSE ................. MIT License Terms
└── README.md ............... Project Documentation

Contributing

Please Read EOS Costa Rica's Open Source Contributing Guidelines.

Please report bugs big and small by opening an issue

About EOS Costa Rica

EOS Costa Rica is an independently-owned, self-funded, bare-metal Genesis block producer that provides stable and secure infrastructure for the EOS mainnet. We support open source software for our community while offering enterprise solutions and custom smart contract development for our clients.