Skip to main content

​
Welcome to Conformly.ai

Get up and running with Conformly.ai in just a few steps.

​
Prerequisites

  • Python 3.11+ (for backend)
  • Node.js 18+ (for frontend)
  • Supabase account
  • Google API key

​
Quick Start

​
1. Backend Setup

cd conformly-backend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp env.example .env
# Edit .env with your credentials
python run.py

​
2. Frontend Setup

cd conformly-frontend
npm install
npm run dev

​
3. Access the Application

  • Frontend: http://localhost:5173
  • Backend API: http://localhost:8000
  • API Docs: http://localhost:8000/docs

​
Next Steps

Backend Installation

Detailed backend setup instructions

API Reference

Explore the API endpoints

Docker Deployment

Deploy using Docker Compose

​
Run Your First Analysis

  1. Upload a standard and a work product in the app.
  2. Start a gap analysis (multi‑standard supported) from the workflow or via the API:
curl -X POST "http://localhost:8000/api/v1/analysis/gaps?standard_ids=std-uuid&work_product_ids=wp-uuid&workspace_id=ws-uuid" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
  1. Track progress by listing analyses for your workspace and open the latest run.
  2. Open Reports → Gaps to triage findings. Use filters for severity/status/standard.
  3. Click View in history to open the Gap Analysis Viewer:
    • Click findings to highlight matching text in the document
    • Export a structured report and “Save as PDF” from the browser print dialog
  4. Update gap status inline (Open / In progress / Resolved / Accepted) to track remediation.