> ## Documentation Index
> Fetch the complete documentation index at: https://tonic-ai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Get up and running with CreditNexus in minutes

## Prerequisites

Before you begin, ensure you have:

* Python 3.11+ installed
* Node.js 20+ installed
* PostgreSQL database

## Installation

### Backend Setup

1. Clone the repository:

```bash theme={null}
git clone https://github.com/josephrp/creditnexus.git
cd creditnexus
```

2. Install dependencies using `uv`:

```bash theme={null}
uv sync
```

3. Set up the database:

**Windows:**

```bash theme={null}
# 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:**

```bash theme={null}
# Start PostgreSQL service
sudo systemctl start postgresql  # Linux
# or
brew services start postgresql@XX  # macOS

# Create database
createdb creditnexus
```

**Or using Docker:**

```bash theme={null}
docker run --name creditnexus-postgres -e POSTGRES_PASSWORD=yourpassword -e POSTGRES_DB=creditnexus -p 5432:5432 -d postgres
```

4. Set up environment variables:

```bash theme={null}
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](/getting-started/configuration) for detailed setup instructions.

5. Run database migrations:

```bash theme={null}
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/`.

6. Start the backend server:

```bash theme={null}
uv run python server.py
```

### Frontend Setup

1. Navigate to the client directory:

```bash theme={null}
cd client
```

2. Install dependencies:

```bash theme={null}
npm install
```

3. Start the development server:

```bash theme={null}
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):**

```powershell theme={null}
.\scripts\launch_openfin.sh
```

**Mac/Linux:**

```bash theme={null}
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](/compliance/fdc3-compliance) and [OpenFin Compliance](/compliance/openfin-compliance) for detailed setup and configuration.

## Next Steps

* Read the [Architecture Overview](/architecture/overview) to understand the system design
* Explore [API Reference](/api-reference/authentication) for integration options
* Check out [Guides](/guides/document-extraction) for detailed workflows
* Set up [OpenFin Desktop Integration](/compliance/openfin-compliance) for enterprise deployment