XYOracleNetwork/app-xyo-nodejs

[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

[![logo]](https://xyo.network)

# app-xyo-nodejs
[![NPM](https://img.shields.io/npm/v/@xyo-network/app-xyo-nodejs.svg?style=plastic)](https://www.npmjs.com/package/@xyo-network/app-xyo-nodejs)

![](https://github.com/XYOracleNetwork/app-xyo-nodejs/workflows/CI/badge.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1f31c7fa87694b8eab91a2d71f74b697)](https://www.codacy.com/app/arietrouw/app-xyo-nodejs?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/app-xyo-nodejs&utm_campaign=Badge_Grade) [![BCH compliance](https://bettercodehub.com/edge/badge/XYOracleNetwork/app-xyo-nodejs?branch=master)](https://bettercodehub.com/)
[![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/XYOracleNetwork/app-xyo-nodejs/maintainability) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=XYOracleNetwork_app-xyo-nodejs&metric=alert_status)](https://sonarcloud.io/dashboard?id=XYOracleNetwork_app-xyo-nodejs) [![Known Vulnerabilities](https://snyk.io/test/github/XYOracleNetwork/app-xyo-nodejs/badge.svg)](https://snyk.io/test/github/XYOracleNetwork/app-xyo-nodejs)

> The XYO Foundation provides this source code available in our efforts to advance the understanding of the XYO Procotol and its possible uses. We continue to maintain this software in the interest of developer education. Usage of this source code is not intended for production.

## Table of Contents

-   [Title](#app-xyo-nodejs)
-   [Description](#description)
-   [Getting Started](#getting-started)
-   [Maintainers](#maintainers)
-   [License](#license)
-   [Credits](#credits)

## Description

This tool is a CLI for to create a node to participate in the XYO Network.

## Getting Started

### Install 

```sh
yarn install
```

### Running `xyolo` commands

Install plugins

```sh
xyolo -i
```
or 

```sh
xyolo --install
```

This should take you through a plugin wizard. Once you have set up your config with plugins then you can run a node. 

Run a node

```sh
xyolo -r
```

or 

```sh
xyolo --run
```

## Maintainers

-   Carter Harrison
-   Arie Trouw

## License

See the [LICENSE.md](LICENSE) file for license details

## Credits

Made with 🔥and ❄️ by [XYO](https://www.xyo.network)