Skip to main content

Prerequisites

Before setting up CFlow for development, ensure you have the following installed on your system.

System Requirements

Hardware

  • RAM: Minimum 8GB (16GB recommended)
  • Storage: 2GB free space for dependencies
  • Processor: Multi-core processor recommended

Operating System

  • macOS 12+ (Monterey or later)
  • Windows 10/11 with WSL2
  • Ubuntu 20.04+ or equivalent Linux distribution

Required Software

Node.js

CFlow requires Node.js 18.x or later.

# Check your Node.js version
node --version

# Should output v18.x.x or higher

Installation options:

npm or pnpm

Package manager for dependencies.

# npm comes with Node.js
npm --version

# Or install pnpm (faster, recommended)
npm install -g pnpm
pnpm --version

Git

Version control for the codebase.

git --version
# Should output git version 2.x.x

Supabase Account

CFlow uses Supabase for database and authentication.

  1. Create account: supabase.com
  2. Create project in your preferred region (eu-west-2 for UK)
  3. Note your credentials:
    • Project URL
    • Anon Key
    • Service Role Key (for admin operations)
tip

You can use Supabase's free tier for development. The project comes with database migrations that will set up all 38 tables automatically.

Code Editor

We recommend Visual Studio Code with these extensions:

  • ESLint - Code linting
  • Prettier - Code formatting
  • TypeScript - TypeScript support
  • Tailwind CSS IntelliSense - Tailwind autocomplete
  • Supabase - Database integration
# Install recommended extensions
code --install-extension dbaeumer.vscode-eslint
code --install-extension esbenp.prettier-vscode
code --install-extension ms-vscode.vscode-typescript-next
code --install-extension bradlc.vscode-tailwindcss

Optional Tools

Supabase CLI

For local database development and migrations.

# Install Supabase CLI
npm install -g supabase

# Or with Homebrew (macOS)
brew install supabase/tap/supabase

Vercel CLI

For deployment management.

npm install -g vercel

Environment Setup Checklist

Before proceeding, verify all requirements:

RequirementCommandExpected
Node.jsnode --versionv18.0.0+
npmnpm --versionv9.0.0+
Gitgit --versionv2.0.0+
Supabase Account-Created
Code Editor-Installed

Next Steps

Once you have all prerequisites installed:

  1. Installation - Clone and set up the project
  2. Environment Setup - Configure environment variables
  3. First Run - Start the development server

Having issues? Check our troubleshooting guide or contact support.