From cf3abe5202cbbce68b89e00ae1bb8fd57fd46ada Mon Sep 17 00:00:00 2001
From: Rotimi Best <best@classroomio.com>
Date: Fri, 27 Sep 2024 02:21:24 +0100
Subject: [PATCH] docs: improve dashboard env example + cloudflare setup

---
 apps/dashboard/.env.example                   | 25 +++++++++++--------
 apps/docs/pages/contributor-guides/_meta.json |  5 ++--
 .../contributor-guides/cloudflare-setup.mdx   |  7 ++++++
 3 files changed, 25 insertions(+), 12 deletions(-)
 create mode 100644 apps/docs/pages/contributor-guides/cloudflare-setup.mdx

diff --git a/apps/dashboard/.env.example b/apps/dashboard/.env.example
index fa226070..76655669 100644
--- a/apps/dashboard/.env.example
+++ b/apps/dashboard/.env.example
@@ -1,37 +1,42 @@
-# Supabase setup - Required
+# *Supabase setup - learn more https://classroomio.com/docs/contributor-guides/supabase-cloud
 PUBLIC_SUPABASE_URL=http://localhost:54321
 PUBLIC_SUPABASE_ANON_KEY=
 PRIVATE_SUPABASE_SERVICE_ROLE=
 
-# Selfhosting
+# Selfhosting - should be true if you are selfhosting
 IS_SELFHOSTED=false
 
 # Unsplash setup - Optional if you want to use Unsplash images
 UNSPLASH_API_KEY=
 
-VITE_SENTRY_AUTH_TOKEN=
-VITE_SENTRY_ORG_NAME=
-VITE_SENTRY_PROJECT_NAME=
-# Configure https locally https://stackoverflow.com/a/76525335
-USE_HTTPS_ON_LOCALHOST=false
-
-# OpenAI setup - Optional if you want to use OpenAI
+# OpenAI setup - Optional if you want to use the AI features
 OPENAI_API_KEY=
 
 # Sever URL - Optional if you want to use video upload and pdf downloads
+# This is the deployment URL of apps/backend
 PUBLIC_SERVER_URL=
 
 # For getting metadata for signup users.
 PUBLIC_IP_REGISTRY_KEY=
 
-# Domain management
+# Domain management - should be your domain
+# The final domain is app.classroomio.com where `app` is PRIVATE_APP_SUBDOMAINS and `classroomio.com` is PRIVATE_APP_HOST
 PRIVATE_APP_HOST=classroomio.com
 PRIVATE_APP_SUBDOMAINS=app
 
+
+# ============  CLOUD VERSION SPECIFIC ============
 LEMON_SQUEEZY_API_KEY=
 LEMON_SQUEEZY_STORE_ID=
 LEMON_SQUEEZY_WEBHOOK_SECRET=
 
+VITE_SENTRY_AUTH_TOKEN=
+VITE_SENTRY_ORG_NAME=
+VITE_SENTRY_PROJECT_NAME=
+
+# Configure https locally https://stackoverflow.com/a/76525335
+USE_HTTPS_ON_LOCALHOST=false
+
 ## Custom Domain
 TEAM_ID_VERCEL=
 PROJECT_ID_VERCEL=
diff --git a/apps/docs/pages/contributor-guides/_meta.json b/apps/docs/pages/contributor-guides/_meta.json
index bee89d3f..4dc53293 100644
--- a/apps/docs/pages/contributor-guides/_meta.json
+++ b/apps/docs/pages/contributor-guides/_meta.json
@@ -4,5 +4,6 @@
   "gitpod": "Gitpod setup",
   "supabase-cloud": "Supabase Cloud Setup",
   "design": "Designers Guide",
-  "student-dashboard": "Student Dashboard"
-}
\ No newline at end of file
+  "student-dashboard": "Student Dashboard",
+  "cloudflare-setup": "Cloudflare Setup"
+}
diff --git a/apps/docs/pages/contributor-guides/cloudflare-setup.mdx b/apps/docs/pages/contributor-guides/cloudflare-setup.mdx
new file mode 100644
index 00000000..180e5705
--- /dev/null
+++ b/apps/docs/pages/contributor-guides/cloudflare-setup.mdx
@@ -0,0 +1,7 @@
+import Image from 'next/image';
+import { Steps } from 'nextra/components';
+import { Callout } from 'nextra/components';
+
+# Cloudflare Setup
+
+In this guide, you will learn how to get your cloudflare environment variables. We use Cloudflare R2 for video uploads and the aim of this guide is to help you get the right variables to properly setup our backend.