Getting Started

Installation

Add Colveor packages to your TypeScript and NestJS project.

Requirements

Colveor targets modern TypeScript and NestJS applications. The examples below are package installation examples — refer to each package's documentation for its specific peer requirements as they are published.

Install Core

Start with the foundational package:

Bash
npm install @colveor/core

Add Fintech

If your product needs financial capabilities, install Fintech alongside Core. Fintech builds on Core's identity and access-control infrastructure.

Bash
npm install @colveor/core @colveor/fintech

Package installation examples

These commands are package installation examples. Exact version ranges and peer dependencies will be documented per release as the ecosystem reaches stable milestones.

DevKit

DevKit is typically added as a development dependency to share tooling and standards across your workspace.

Bash
npm install --save-dev @colveor/devkit