Skip to content

Latest commit

 

History

History
120 lines (80 loc) · 4.03 KB

README.md

File metadata and controls

120 lines (80 loc) · 4.03 KB

Storyscript Open Microservice

This is the Storyscript compiler as as service

Open Microservice Specification Version Open Microservices Spectrum Chat Open Microservices Code of Conduct Open Microservices Commitzen PRs Welcome License: MIT

Introduction

This project is an example implementation of the Open Microservice Specification, a standard originally created at Storyscript for building highly-portable "microservices" that expose the events, actions, and APIs inside containerized software.

Getting Started

The oms command-line interface allows you to interact with Open Microservices. If you're interested in creating an Open Microservice the CLI also helps validate, test, and debug your oms.yml implementation!

See the oms-cli project to learn more!

Installation

npm install -g @microservices/oms

Usage

Open Microservices CLI Usage

Once you have the oms-cli installed, you can run any of the following commands from within this project's root directory:

Actions

lex
Action Arguments
Argument Name Type Required Default Description
files map true None No description provided.
oms run lex \
    -a files='*****'
parse
Action Arguments
Argument Name Type Required Default Description
files map true None No description provided.
oms run parse \
    -a files='*****'
compile
Action Arguments
Argument Name Type Required Default Description
files map true None No description provided.
oms run compile \
    -a files='*****'
grammar
oms run grammar
version
oms run version

Contributing

All suggestions in how to improve the specification and this guide are very welcome. Feel free share your thoughts in the Issue tracker, or even better, fork the repository to implement your own ideas and submit a pull request.

Edit storyscript on CodeSandbox

This project is guided by Contributor Covenant. Please read out full Contribution Guidelines.

Additional Resources