XYO ARCHIVIST SDK (sdk-archivist-nodejs)

Table of Contents

• Title
• Project Overview
• Scope of features
• Install
• Usage
• Maintainers
• Contributing
• License
• Credits

Project Overview

Scope of features

Core functionality for the XYO NodeJS archivist. This repository implements the core objects and services used in the XYO protocol by an archivist. Additionally it provides core XYO features like performing block production, data generation, TCP Network services, and database services.

Install

Clone Repository

 git clone https://github.com/XYOracleNetwork/sdk-archivist-nodejs.git

Install

 yarn install

Build

 yarn build

Use Mock Data

 yarn mock-data

Test

 yarn test

Contributing

Developer Guide

Git Branch Standards

Make sure that the branch you are on is current and checked out from the most updated remote state

A key while working in a project is to ensure that you have the latest code from the other branches. especially those that you have checked out from.

Remember to frequently:

git fetch --all git pull <remote name - ususally origin> <branch name>

We would recommend that you do this before pushing your committed code.

NOTE Related: make sure that you are in communication with your project team, and that you check GitHub for updates to the codebase, especially the branch that you are checked out from.

Naming Your Branches

When you are checkout out new branches and naming them, you should follow a solid git flow method as outlined below:

• For feature branches feature/<feature you are working on>
• For bug fix branches - hot hotfix/<hotfix you are working on>
• For bug fix branches fix/<fix you are working on> NOTE Only if this bug-fix will not interfere with dev worklflow
• For release branch release/<version number> NOTE Only if your project is working off of a release before merge into master

Git Flow

NOTE: Only the Develop and Release Branch can be merged into Master

In order to ensure that production-ready software is truly ready, we need to maintain a strong git flow. This means that we should only merge our develop or release branch into master - essentially we want to lock the master, release and develop branches. The develop branch should be the home for all tested and production ready code that is ready for a final review with included checks before being brought into master, we can also use release for production staging. All checks would include CI/CD and code quality.

For feature branches, you should git checkout -b feature/<what feature name you are working on> NOTE Feature branches should always and only be checked out from the latest develop branch.

Bug fixes, documentation updates, and minor styling should be done through a release branch which would be checked out from the latest develop branch after all feature branches have been merged into the develop branch.

The develop branch should also be where we conduct full app testing, as opposed to feature specific. To test features, you should make sure that all feature specifc tests pass in the feature branch that you are working on.

If you feel you may need to do a hot-fix directly to master, please communicate when to do this. Do Not Take Hot Fixes Lightly

Tools

• yarn package manager
• eslint
• tslint
• typescript
• Use @storybook dependencies
• Use @type dependencies

Maintainers

• Carter Harrison
• Arie Trouw

License

See the LICENSE file for license details.

Credits

Made with 🔥and ❄️ by XYO