​
Quickstart Guide

This guide provides a quick overview of getting started with CONA. For detailed setup instructions and configuration, please refer to our root README.

​
Prerequisites

  • Node.js 18+
  • PNPM (latest version)
  • PostgreSQL database
  • Supabase account
  • Temporal Cloud account
  • Mintlify CLI (for documentation)

​
Quick Setup

  1. Clone and install:
git clone https://github.com/CONA-app/CONA.git
cd cona
pnpm install
  1. Configure environment:
cp .env.example .env.local

See the Environment Setup Guide for a complete list of required environment variables and their descriptions.

  1. Push database schema and start development:
pnpm prisma db push
pnpm dev

Visit http://localhost:3000 to access the application.

​
Documentation Development

  1. Install Mintlify CLI globally:
npm i -g mintlify
  1. Start the documentation server:
cd apps/internal-docs
mintlify dev --port 4000

Visit http://localhost:4000 to preview the documentation.

For more details about working with our documentation, see the docs guide.

​
Development Best Practices

  1. Package Management

    • Always use PNPM for package management
    • Run scripts using pnpm run or pnpm test

  2. Code Style

    • Write functional TypeScript code
    • Follow established project structure
    • Use descriptive variable names

​
Next Steps