https://github.com/dictybase/modware-order

dictyBase grpc service to manage order of biological stocks
https://github.com/dictybase/modware-order

golang grpc

Last synced: 2 months ago
JSON representation

dictyBase grpc service to manage order of biological stocks

• Host: GitHub
• URL: https://github.com/dictybase/modware-order
• Owner: dictyBase
• License: bsd-2-clause
• Created: 2018-12-03T16:42:41.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-11-09T17:26:46.000Z (over 1 year ago)
• Last Synced: 2025-03-04T20:40:36.539Z (over 1 year ago)
• Topics: golang, grpc
• Language: Go
• Homepage:
• Size: 930 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# modware-order

[![License](https://img.shields.io/badge/License-BSD%202--Clause-blue.svg)](LICENSE)  

![Continuous integration](https://github.com/dictyBase/modware-order/workflows/Continuous%20integration/badge.svg)

[![codecov](https://codecov.io/gh/dictyBase/modware-order/branch/develop/graph/badge.svg)](https://codecov.io/gh/dictyBase/modware-order)

[![Maintainability](https://api.codeclimate.com/v1/badges/f6b7067bd24eab14ba0d/maintainability)](https://codeclimate.com/github/dictyBase/modware-order/maintainability)   

![Last commit](https://badgen.net/github/last-commit/dictyBase/modware-order/develop)   

[![Funding](https://badgen.net/badge/Funding/Rex%20L%20Chisholm,dictyBase,DCR/yellow?list=|)](https://reporter.nih.gov/project-details/10024726)

dictyBase API server to manage order of biological stocks. The API server supports gRPC protocol for data exchange.

## Usage

```

NAME:

   modware-order - cli for modware-order microservice

USAGE:

   modware-order [global options] command [command options] [arguments...]

VERSION:

   1.0.0

COMMANDS:

     start-server  starts the modware-order microservice with grpc backends

     help, h       Shows a list of commands or help for one command

GLOBAL OPTIONS:

   --log-format value  format of the logging out, either of json or text. (default: "json")

   --log-level value   log level for the application (default: "error")

   --help, -h          show help

   --version, -v       print the version

```

## Subcommand

```

NAME:

   modware-order start-server - starts the modware-order microservice with grpc backends

USAGE:

   modware-order start-server [command options] [arguments...]

OPTIONS:

   --arangodb-pass value, --pass value    arangodb database password [$ARANGODB_PASS]

   --arangodb-database value, --db value  arangodb database name [$ARANGODB_DATABASE]

   --arangodb-user value, --user value    arangodb database user [$ARANGODB_USER]

   --arangodb-host value, --host value    arangodb database host (default: "arangodb") [$ARANGODB_SERVICE_HOST]

   --arangodb-port value                  arangodb database port (default: "8529") [$ARANGODB_SERVICE_PORT]

   --is-secure                            flag for secured or unsecured arangodb endpoint

   --nats-host value                      nats messaging server host [$NATS_SERVICE_HOST]

   --nats-port value                      nats messaging server port [$NATS_SERVICE_PORT]

   --port value                           tcp port at which the server will be available (default: "9560")

   --order-collection value               arangodb collection for storing stock orders (default: "stock_order")

   --reflection, --ref                    flag for enabling server reflection

```

## Default Names

There is only one collection, and its default name is **stock_order**.

# API

### gRPC

The protocol buffer definitions and service apis are documented

[here](https://github.com/dictyBase/dictybaseapis/blob/master/dictybase/order/order.proto).

# Misc badges

![Issues](https://badgen.net/github/issues/dictyBase/modware-order)

![Open Issues](https://badgen.net/github/open-issues/dictyBase/modware-order)

![Closed Issues](https://badgen.net/github/closed-issues/dictyBase/modware-order)  

![Total PRS](https://badgen.net/github/prs/dictyBase/modware-order)

![Open PRS](https://badgen.net/github/open-prs/dictyBase/modware-order)

![Closed PRS](https://badgen.net/github/closed-prs/dictyBase/modware-order)

![Merged PRS](https://badgen.net/github/merged-prs/dictyBase/modware-order)  

![Commits](https://badgen.net/github/commits/dictyBase/modware-order/develop)

![Branches](https://badgen.net/github/branches/dictyBase/modware-order)

![Tags](https://badgen.net/github/tags/dictyBase/modware-order)  

[![Lines of Code](https://badgen.net/codeclimate/loc/dictyBase/modware-order)](https://codeclimate.com/github/dictyBase/modware-order/code)