Skip to main content

​
Prerequisites

Before you begin, ensure you have:
  • Python 3.11+ installed
  • Node.js 20+ installed
  • PostgreSQL database

​
Installation

​
Backend Setup

  1. Clone the repository:
git clone https://github.com/josephrp/creditnexus.git
cd creditnexus
  1. Install dependencies using uv:
uv sync
  1. Set up the database:
Windows: 
# Start PostgreSQL service using the psql client - use your own path
"C:\Program Files\PostgreSQL\18\bin\psql.exe" -U postgres -c "CREATE DATABASE creditnexus;"
Linux/macOS: 
# Start PostgreSQL service
sudo systemctl start postgresql  # Linux
# or
brew services start postgresql@XX  # macOS

# Create database
createdb creditnexus
Or using Docker: 
docker run --name creditnexus-postgres -e POSTGRES_PASSWORD=yourpassword -e POSTGRES_DB=creditnexus -p 5432:5432 -d postgres
  1. Set up environment variables:
cp .env.example .env
# Edit .env with your configuration (database URL, API keys, etc.)
💡 Tip: The .env.example file contains all available configuration options with documentation. See the Configuration Guide for detailed setup instructions.
  1. Run database migrations:
uv run alembic upgrade head
This will create all necessary tables (documents, workflows, policy_decisions, users, etc.) based on the migration files in alembic/versions/.
  1. Start the backend server:
uv run python server.py

​
Frontend Setup

  1. Navigate to the client directory:
cd client
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

​
First Steps

  1. Access the application: Open http://localhost:5173 in your browser
  2. Login or Register: Create an account or login with existing credentials
  3. Upload a Document: Navigate to the Document Parser and upload a credit agreement
  4. View Extracted Data: Review the extracted CDM data in the library
  5. Generate Documents: Use the Document Generator to create LMA templates from your data

​
OpenFin Desktop Integration (Optional)

CreditNexus supports OpenFin Runtime for enterprise desktop deployment with FDC3 2.0 interoperability.

​
Quick Launch

Windows (PowerShell): 
.\scripts\launch_openfin.sh
Mac/Linux: 
bash scripts/launch_openfin.sh
This will:
  1. Check that backend and frontend services are running
  2. Verify the FDC3 App Directory is accessible at http://localhost:8000/api/fdc3/apps
  3. Launch OpenFin with the configured app manifest

​
FDC3 2.0 Compliance

CreditNexus is fully compliant with FDC3 2.0 standards:
  • ✅ App Directory API: Automatically served at /api/fdc3/apps
  • ✅ Context Types: All custom contexts use finos.creditnexus.* namespace
  • ✅ Intent Handling: Full support for intent listeners and raisers
  • ✅ Native OpenFin Integration: Uses built-in FDC3 2.0 API
📖 Learn More: See FDC3 Compliance and OpenFin Compliance for detailed setup and configuration.

​
Next Steps