Back to Home

Documentation

Everything you need to deploy, configure, and operate Nova CBS. From quick start guides to detailed API references.

API Reference
Swagger Docs
GitHub

Getting Started

Quick start guide to get Nova CBS up and running

Backend API

Complete API reference for all endpoints

Database

Database schema and entity documentation

Security

Security features and best practices

Quick Start Installation

1. Clone the Repository

git clone https://github.com/novacbs/cbs-me.git
cd cbs-me

2. Install Dependencies

pnpm install

3. Configure Environment

# Copy environment template
cp apps/app-backend/.env.example apps/app-backend/.env

# Edit with your database credentials
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_NAME=nova_cbs
DATABASE_USER=postgres
DATABASE_PASSWORD=your_password

# Redis configuration
REDIS_HOST=localhost
REDIS_PORT=6379

4. Run Database Migrations

cd apps/app-backend
pnpm migration:run

5. Start the Application

# Start backend (port 3000)
pnpm --filter app-backend dev

# Start dashboard (port 3113)
pnpm --filter finance-dashboard dev

# Or start all apps
pnpm dev

API Overview

Authentication

JWT-based authentication with refresh tokens

POST/v1/api/auth/loginLogin with credentials
POST/v1/api/auth/refreshRefresh access token
POST/v1/api/auth/logoutLogout and invalidate token

Banking Operations

Core banking API endpoints

GET/v1/api/banking/customersList customers
POST/v1/api/banking/customersCreate customer
GET/v1/api/savings/accountsList savings accounts
POST/v1/api/loans/applySubmit loan application
View Full API Documentation