Skip to content

SmartOperatingBlock/building-management-microservice

Repository files navigation

Building Management microservice

workflow status License: MIT Version

codecov Code Smells Vulnerabilities Duplicated Lines (%) Quality Gate Status Technical Debt Security Rating

This is the repository of the Building Management microservice of the Smart Operating Block project.

Usage

You need to specify the following environment variable:

  • AZURE_CLIENT_ID: ID of an Azure AD application
  • AZURE_TENANT_ID: ID of the application's Azure AD tenant
  • AZURE_CLIENT_SECRET: the application's client secrets
  • AZURE_DT_ENDPOINT: the Azure Digital Twins instance endpoint
  • MONGODB_CONNECTION_STRING: the mongodb's connection string
  • BOOTSTRAP_SERVER_URL: the kafka connection endpoint
  • SCHEMA_REGISTRY_URL: the schema registry url

If you want to run it via docker container:

  1. Provide a .env file with all the environment variable described above
  2. Run the container with the command:
     docker run ghcr.io/smartoperatingblock/building-management-microservice:latest
    1. If you want to try the REST-API from the external you need to provide a port mapping to port 3000.
    2. If you want to pass an environment file whose name is different from .env use the --env-file <name> parameter.

Documentation

  • Check out the website here
  • Direct link to the REST-API documentation here
  • Direct link to the Code documentation here