Requirements

Running the API Locally

Windows

Requirements for running the API locally (Windows)

Mandatory (Locally)

• .NET 8 SDK and Runtime 8.0.* or higher (for .NET 8 projects).
• CosmosDB Emulator 2.4.5+.

Optional

• Visual Studio 2022.
• Visual Studio Code 1.35+ with the C# extension.

Additional requirements for running the API in Docker containers (Windows)

Mandatory (Docker)

• Docker Desktop for Windows: Version 2.1.0.1 (or higher).
  • Enable:
    • Kubernetes 1.14+.
    • Linux containers (not Windows containers).
  • Docker Engine 19.03.1+ (included with Docker).
  • Windows Subsystem for Linux (WSL) for running Linux environment scripts (recommended v1, v2 is still in testing).
  • kubectl v1.14+ (included with Docker).
    • You can also download it separately.

Additional requirements for running the API in a Kubernetes cluster

• NGINX Ingress Controller:
  • Install it in your local cluster.
  • Follow the Bare Metal deployment guide.

MacOS

Requirements for running the API locally (MacOS)

• Homebrew: A package manager for macOS.
• Azure CLI: Install it via brew install azure-cli.
• .NET 8 SDK: Install it via brew install --cask dotnet-sdk.
• CosmosDB Emulator: Only available for Windows. If you use Azure, you can run CosmosDB in the cloud.

Additional requirements for running the API in Docker containers (MacOS)

• Docker Desktop for Mac.
• kubectl: Run docker run --name kubectl bitnami/kubectl:latest to install.

---

Note

The current version of Ensono Stacks uses .NET 8 (the latest Long Term Support version, recommended).