Skip to content

01-prerequisites.md

Latest commit

 

History

History
83 lines (52 loc) · 1.47 KB

01-prerequisites.md

File metadata and controls

83 lines (52 loc) · 1.47 KB

Prerequisites

Before you can run the Datum Cloud Portal locally, ensure you have the following tools and access.

Required Tools

Bun (Runtime)

Bun is the JavaScript runtime used for this project.

# Install Bun
curl -fsSL https://bun.sh/install | bash

# Verify installation
bun --version  # Should be >= 1.2.17

Node.js

Some tooling still requires Node.js.

# Verify installation
node --version  # Should be >= 20.0.0

Git

git --version  # Should be >= 2.x

Required Access

Before starting development, ensure you have:

  • GitHub access to the datum/cloud-portal repository
  • OIDC credentials from your authentication provider
  • Control Plane API access for fetching OpenAPI specs (optional for initial setup)

Recommended Tools

IDE

  • VS Code (recommended) with extensions:
    • ESLint
    • Prettier - Code formatter
    • Tailwind CSS IntelliSense
    • TypeScript Vue Plugin (Volar) - for better TS support

Docker Desktop

Required for running the local observability stack (Grafana, Prometheus, Jaeger).

docker --version
docker-compose --version

Checkpoint

Run this command to verify all required tools are installed:

bun --version && node --version && git --version

Expected output: All three version numbers displayed without errors.

Next Step

Once prerequisites are met, proceed to Environment Setup.