Evernode All-in-One Developer Kit

This package consolidates existing CLI tools, such as hpdevkit and evdevkit, along with Evernode development-related npm packages, into a single development kit. Depending on the installation mode, it can function either as a CLI tool or as a composite npm package.

Install as a CLI Tool (Global)

Prerequisites

The Evernode Kit requires the installation of Node.js on your development machine, as well as Docker to function as a CLI tool.

Cross-Platform Support

This is a global npm package that supports both Linux and Windows.

1. Install the prerequisites.
2. Run the following command to install evernode on your machine:

   npm install evernode -g

Usage

Once installed as a CLI tool, use the evernodecli command to interact with the kit. To view the available commands, run:

evernodecli help

Updates

To update evernodecli to the latest version, run one of the following commands:

evernodecli update

Uninstall

To uninstall evernodecli:

evernodecli uninstall

Note: On Linux platforms, for installation, updates, and uninstallation, you may need root privileges. Prefix the above commands with sudo.

Install as an npm Package (Local)

Prerequisites

The Evernode Kit requires the installation of Node.js on your development machine.

Usage

1. Install the prerequisites.
2. Create a directory and run the npm init command to initialize a Node.js workspace.
3. Run the following command to install evernode locally:

   npm install evernode

4. In your Node.js file, require the package as follows:

   /*
       You can use this library to access the following built-in npm packages:
       - EvernodeClient: evernode-js-client
       - HotPocketClient: hotpocket-js-client
       - HotPocketContract: hotpocket-nodejs-contract
       - EverPocketContract: everpocket-nodejs-contract
   
       Example usage:
       const { EvernodeClient, HotPocketClient, HotPocketContract, EverPocketContract } = require('evernode');
   */
   const { EvernodeClient } = require('evernode');
   
   async function main() {
       await EvernodeClient.Defaults.useNetwork('testnet');
       governorAddress = EvernodeClient.Defaults.values.governorAddress;
       console.log('Governor address:', governorAddress);
   }
   
   main()

Updates

To update evernode to the latest version, run:

npm update evernode