@monaxlabs/spec

Monax Labs Specs

This repo contains a number of computable specs for the Monax Labs including Aspen.

OpenAPI spec for our APIs can be found in the api/ directory and custom specifications for our contracts can be found under contracts/.

pkg/@monaxlabs/spec
├── apis
│       ├── identity.json
│       ├── publishing.json
│       └── trading.json
├── contracts
│       ├── deployments.json
│       └── manifest.json
├── node_modules
├── package.json
├── README.md
└── yarn.lock

Prerequisites

This project requires NodeJS (version 8 or later) with NPM or the Yarn package manader. Node NPM and are really easy to install while a good start to the Yarn ecosystem can be found here

Installation

BEFORE YOU INSTALL: please read the prerequisites

$ git clone https://github.com/monax/aspen.git
$ cd pkg
$ cd spec

To install and set up the library, run:

$ npm install -S @monaxlabs/spec

Or if you prefer using Yarn:

$ yarn add --dev @monaxlabs/spec

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See the manifest.json and deployment.json folders to see how they work and how you can use them in your project.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request :sunglasses: