Nanometers Per Millisecond

    This package has been deprecated

    Author message:

    Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

    @xyo-network/api-xyo-nodejs
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.11 • Public • Published

    logo

    XYO API (api-xyo-nodejs)

    Branches

    Master

    Build Status BCH compliance Maintainability Greenkeeper badge

    Develop

    Build Status BCH compliance

    Description

    The main API for accessing XYO network information using GraphQL.

    User Mode

    Requirements (Step 1)

    Install Node 10.x or later from: NodeJs

    Install Diviner (Step 2)

    sudo npm install @xyo-network/api-xyo-nodejs -g --unsafe-perm=true

    Build Diviner (Step 3)

    xyo-api start

    Developer Mode

    Requirements (Step 1)

    Install Node 10.x or later from: NodeJs

    Install Diviner (Step 2)

    npm install https://github.com/XYOracleNetwork/api-xyo-nodejs

    Build Diviner (Step 3)

    npm run build

    Start Diviner (Step 4)

    npm run start

    Docker

    Install

    Install the Xyo Api in a Docker and start the server at the end.

    Note: There currently are quite a few build errors/warnings generted from dependencies that can safely be ignored, but should addressed in the future.

    docker image build -t xyonetwork-api-xyo-nodejs-install:latest https://raw.githubusercontent.com/XYOracleNetwork/api-xyo-nodejs/master/docker/install/Dockerfile
    docker run -p 12001:12001 xyonetwork-api-xyo-nodejs-install:latest

    Command Line

    Usage

      xyo-api <cmd> [opt]
    
      <cmd>: commands
      [opt]: options

    Commands

      start               Start the Api Server

    Options

      -g, --graphql [n]   The http port to listen on for graphql connections
                          (default = 12001)
    
      -d, --diviner [s]   The url of the seed diviner to contact
                          (default = http://diviners.xyo.network:12002)

    Example: Start the API on port 9090 and use port 9099 on your local computer for the diviner

      xyo-api start -g 9090 -d http://localhost:9099

    License

    Only for internal XY Company use at this time

    Credits

    Made with ❤️ by XYO

    Keywords

    none

    Install

    npm i @xyo-network/api-xyo-nodejs

    DownloadsWeekly Downloads

    11

    Version

    0.1.11

    License

    ISC

    Unpacked Size

    220 kB

    Total Files

    246

    Last publish

    Collaborators

    • donaldparkerxy
    • joelbcarter
    • jonesmac
    • jordantrouw
    • ricardo.alcazar
    • rphansen91
    • xyo