Getting Started

Quick Start

A high-level walkthrough of introducing Colveor into a NestJS application.

Conceptual example

The snippets below are conceptual and illustrate the intended shape of integration. Exact module names, options and APIs are documented as they stabilize — do not treat these as final signatures.

1. Install

Bash

npm install @colveor/core

2. Register modules

app.module.ts

TypeScript

import { Module } from '@nestjs/common'
import { ColveorCoreModule } from '@colveor/core'

@Module({
  imports: [
    ColveorCoreModule.forRoot({
      // Configuration is provided through the application's
      // environment and settings infrastructure.
    }),
  ],
})
export class AppModule {}

3. Configure

Core reads configuration through the application's configuration and settings layers. See Configuration for the conceptual model.

colveor.config.json

JSON

{
  "core": {
    "auth": { "methods": ["email-password", "phone-otp"] },
    "sessions": { "enabled": true }
  }
}

Next steps

Architecture

Understand how Core and Fintech layer together.

Authentication

Explore configurable authentication methods.

RBAC

Model access with modules, permissions and roles.

Fintech

Add wallets and transactions on top of Core.