GitHub Codespaces

Develop with Islamic Open Finance™ using GitHub Codespaces.

Overview

Codespaces provides a complete development environment in the cloud:

Pre-configured environment
All dependencies installed
Databases running automatically
No local setup required

Quick Start

1. Open in Codespaces

Or from the repository:

Click the Code button
Select Codespaces tab
Click Create codespace on main

2. Wait for Setup

The codespace automatically:

Installs Node.js 22
Installs pnpm dependencies
Starts database and cache services
Runs database migrations

3. Start Development

# Start all services
pnpm dev

# Or start specific services
pnpm dev:rail-api
pnpm dev:admin-portal

Available Ports

Port	Service
3000	Rail API
3001	Admin Portal
3002	API Explorer
5432	Database
6379	Cache

Environment Variables

Codespaces automatically sets up:

DATABASE_URL=<auto-configured>
CACHE_URL=<auto-configured>
JWT_SECRET=codespaces-dev-secret

Persistence

Codespaces persist:

✅ Code changes
✅ Database data
✅ VS Code settings
✅ Terminal history

Tips

Pre-build Configuration

The repository includes .devcontainer/devcontainer.json:

{
  "name": "IOF Development",
  "image": "mcr.microsoft.com/devcontainers/typescript-node:22",
  "features": {
    "ghcr.io/devcontainers/features/docker-in-docker:2": {}
  },
  "postCreateCommand": "pnpm install",
  "forwardPorts": [3000, 3001, 3002, 5432, 6379]
}

Resource Limits

Machine Type	CPU	Memory
2-core	2	4 GB
4-core	4	8 GB
8-core	8	16 GB

Recommended: 4-core for development.

Next Steps

Getting Started - Development guide
API Reference - Available endpoints