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
β βββ aspen.json
βββ contracts
β βββ deployments.json
β βββ manifest.json
β βββ manifest.pending.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
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
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Add your changes:
git add .
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :sunglasses: