flocore-node/docs/scaffold.md
2018-01-15 16:43:07 -08:00

21 lines
997 B
Markdown

# Scaffold
A collection of functions for creating, managing, starting, stopping and interacting with a Flocore node.
## Install
This function will add a service to a node by installing the necessary dependencies and modifying the `flocore-node.json` configuration.
## Start
This function will load a configuration file `flocore-node.json` and instantiate and start a node based on the configuration.
## Find Config
This function will recursively find a configuration `flocore-node.json` file in parent directories and return the result.
## Default Config
This function will return a default configuration with the default services based on environment variables, and will default to using the standard `/home/user/.florincoin` data directory.
## Uninstall
This function will remove a service from a node by uninstalling the necessary dependencies and modifying the `flocore-node.json` configuration.
## Call Method
This function will call an API method on a node via the JSON-RPC interface.