Skip to content

specmesh/helloworld-demo

Repository files navigation

License Coverage Status build CodeQL

SpecMesh Hello World Demo

A Quick example of writing a spec and a test of its functionality

Building

Prerequisites

You'll need the Protobuf compiler protoc installed on your system. How to do this will vary depending on your OS

  • For MacOS run brew install protobuf. (You do have Home brew installed, right?)
  • For Linux using Apt package manager, run sudo apt install protobuf-compiler.

Structure

api module

Contains the Async API spec that defines the API of the domain, a.k.a. bounded context.

app module

This module would normally contain a microservice that implements the domain. Often there would be multiple services. However, the actual writing to a service is outside the scope of SpecMesh. Therefore, this module only contains a functional test that demonstrates producing and consuming the types to the topics in the spec.