Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/S4nti4goCoder/cloudsyncpro/llms.txt

Use this file to discover all available pages before exploring further.

CloudSyncPro is a React 19 single-page application backed by Supabase (auth, Postgres, Edge Functions, Realtime) and Cloudflare R2 for file storage. This guide walks you through every step — from cloning the repository to creating your first workspace in the running UI.
Before you begin, make sure you have:
  • Node.js ≥ 20 installed (node -v to check)
  • A Supabase project — the free tier works for development
  • A Cloudflare account with R2 enabled
1

Clone the repo and install dependencies

Clone the repository and install npm packages:
git clone <your-repo>.git cloudsyncpro
cd cloudsyncpro
npm install
2

Copy .env.example and fill in your credentials

Create a local environment file from the provided example:
cp .env.example .env.local
Open .env.local and fill in the three required client-side variables:
VariableWhere to find it
VITE_SUPABASE_URLSupabase Dashboard → Project Settings → API
VITE_SUPABASE_ANON_KEYSupabase Dashboard → Project Settings → API
VITE_R2_PUBLIC_URLYour R2 bucket’s custom domain or pub.r2.dev URL
The server-side variables (R2_*, SUPABASE_SERVICE_ROLE_KEY, CRON_SECRET) are used by Supabase Edge Functions and should be set as secrets in the Supabase Dashboard — not in .env.local. See Environment variables for the full reference.
3

Start the development server

npm run dev
The app starts at http://localhost:5173. The dev server includes hot module replacement, so changes to source files are reflected immediately without a full reload.
4

Create your first workspace

  1. Open http://localhost:5173 in your browser. You’ll be redirected to /login.
  2. Register a new account or sign in with an existing one.
  3. After signing in, go to Workspaces in the sidebar and create your first workspace.
  4. Invite team members, upload files, and explore the dashboard.

Build docs developers (and LLMs) love

Get started for freeTalk to us