From 92f22c2f1920dde81365ea2e5910dd02430912bb Mon Sep 17 00:00:00 2001
From: Waleed Latif <walif6@gmail.com>
Date: Sun, 16 Feb 2025 02:03:20 -0800
Subject: [PATCH] docs: include .env.example

---
 .env.example | 16 ++++++++++++++++
 .gitignore   |  2 +-
 2 files changed, 17 insertions(+), 1 deletion(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000000..7b8f07b393
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,16 @@
+# Database (Required)
+DATABASE_URL="postgresql://postgres:password@localhost:5432/postgres"
+
+# Authentication (Required)
+BETTER_AUTH_SECRET=your_secret_key  # Use `openssl rand -hex 32` to generate
+BETTER_AUTH_URL=http://localhost:3000
+
+# Email Provider (Required)
+RESEND_API_KEY=your_resend_api_key  # Get from https://resend.com
+
+# GitHub OAuth (Optional)
+GITHUB_CLIENT_ID=your_github_client_id
+GITHUB_CLIENT_SECRET=your_github_client_secret
+
+# App URL (Required)
+NEXT_PUBLIC_APP_URL=http://localhost:3000
diff --git a/.gitignore b/.gitignore
index 90e480342a..49e64c3b33 100644
--- a/.gitignore
+++ b/.gitignore
@@ -31,7 +31,7 @@ yarn-error.log*
 .pnpm-debug.log*
 
 # env files (can opt-in for committing if needed)
-.env*
+.env
 
 # vercel
 .vercel