More documentation about specific services and components can be found in the following sections:
- deployment/ - Provisioning, Deployment automation, how to's, playbooks and procedures
- services/api - Data API and data model layer that powers all applications
- services/web - Web application and administration dashboard
- bedrockio/ai - AI and LLM utilities (moved out of this repo)
Using Docker Compose you can build and run all services and dependencies as follows:
docker compose upOpen the dashboard at http://localhost:2200/ - Admin login credentials can be seen in the API output.
This repo uses pnpm. Install it by following
pnpm.io/installation. Each service's package.json pins pnpm
via packageManager and Node via devEngines.runtime, so pnpm install downloads the
pinned Node. Each service is installed independently from its own directory:
cd services/api && pnpm install # likewise services/webEach service's pnpm-workspace.yaml enables a few pnpm
supply-chain protections:
minimumReleaseAge: 10080— refuse to install any package version published less than 7 days ago (lets malware in a fresh release be caught before it lands here). A too-new pin in the lockfile is rejected on install; re-resolve to pick a compliant version.blockExoticSubdeps: true— block transitive dependencies that resolve from git/tarball URLs instead of the registry.allowBuilds:— an explicit allowlist of the only dependencies permitted to run install scripts (pnpm blocks all others by default). Add a package here if a build it needs is being skipped.
Worktrees work out of the box — pnpm shares the global content-addressable store across all
worktrees via hardlinks, so each worktree's pnpm install is fast and disk-cheap.
pnpm also has a global virtual store that would additionally
share the .pnpm symlink farm across worktrees. It is not enabled here; the shared content
store above already makes worktree installs fast and cheap. It can be turned on per machine via
global pnpm config if wanted, since these packages use pnpm's default node_modules layout.
Full portal with examples: http://localhost:2200/docs/getting-started