make PAT optional, avoid PostHog init error, update readme

Author: ahmedkhaleel2004

.env.example

@@ -3,4 +3,6 @@ NEXT_PUBLIC_API_DEV_URL=http://localhost:8000
 
 # backend
 ANTHROPIC_API_KEY=
+
+# OPTIONAL: providing your own GitHub PAT increases rate limits from 60/hr to 5000/hr to the GitHub API
 GITHUB_PAT=

.gitignore

@@ -35,6 +35,7 @@ yarn-error.log*
 # do not commit any .env files to git, except for the .env.example file. https://create.t3.gg/en/usage/env-variables#using-environment-variables
 .env
 .env*.local
+.env-e
 
 # vercel
 .vercel

README.md

@@ -1,4 +1,4 @@
-[![Image](./docs/readme_img.png "GitDiagram Front Page")](https:/gitdiagram.com/)
+[![Image](./docs/readme_img.png "GitDiagram Front Page")](https://gitdiagram.com/)
 
 ![License](https://img.shields.io/badge/license-MIT-blue.svg)
 
@@ -47,7 +47,7 @@ pnpm i
 cp .env.example .env
 ```
 
-Then edit the `.env` file with your Anthropic API key and GitHub personal access token.
+Then edit the `.env` file with your Anthropic API key and optional GitHub personal access token.
 
 4. Run backend
 
@@ -56,6 +56,7 @@ docker-compose up --build -d
 ```
 
 Logs available at `docker-compose logs -f`
+The server will be available at `localhost:8000`
 
 5. Start local database
 
@@ -64,12 +65,16 @@ chmod +x start-database.sh
 ./start-database.sh
 ```
 
+The database will start in a container at `localhost:5432`
+
 6. Initialize the database schema
 
 ```bash
 pnpm db:push
 ```
 
+You can view and interact with the database using `pnpm db:studio`
+
 7. Run Frontend
 
 ```bash
@@ -82,7 +87,7 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 
 ## 📈 Rate Limits
 
-I am currently hosting it for free with the following rate limits. If you would like to bypass these, self-hosting instructions are provided.
+I am currently hosting it for free with the following rate limits. If you would like to bypass these, self-hosting instructions are provided. I also plan on adding an input for your own Anthropic API key.
 
 Diagram generation:
 

backend/app/services/github_service.py

@@ -18,9 +18,9 @@ def __init__(self):
         # Fallback to PAT if app credentials not found
         self.github_token = os.getenv("GITHUB_PAT")
 
+        # If no credentials are provided, warn about rate limits
         if not all([self.client_id, self.private_key, self.installation_id]) and not self.github_token:
-            raise ValueError(
-                "Either GitHub App credentials or PAT must be provided")
+            print("\033[93mWarning: No GitHub credentials provided. Using unauthenticated requests with rate limit of 60 requests/hour.\033[0m")
 
         self.access_token = None
         self.token_expires_at = None
@@ -56,8 +56,14 @@ def _get_installation_token(self):
         return self.access_token
 
     def _get_headers(self):
-        # Use PAT if app credentials not available
-        if not all([self.client_id, self.private_key, self.installation_id]):
+        # If no credentials are available, return basic headers
+        if not all([self.client_id, self.private_key, self.installation_id]) and not self.github_token:
+            return {
+                "Accept": "application/vnd.github+json"
+            }
+
+        # Use PAT if available
+        if self.github_token:
             return {
                 "Authorization": f"token {self.github_token}",
                 "Accept": "application/vnd.github+json"

src/app/providers.tsx

@@ -4,11 +4,22 @@ import posthog from "posthog-js";
 import { PostHogProvider } from "posthog-js/react";
 
 if (typeof window !== "undefined") {
-  posthog.init(process.env.NEXT_PUBLIC_POSTHOG_KEY!, {
-    api_host: process.env.NEXT_PUBLIC_POSTHOG_HOST!,
-    person_profiles: "always",
-  });
+  // Only initialize PostHog if the environment variables are available
+  const posthogKey = process.env.NEXT_PUBLIC_POSTHOG_KEY;
+  const posthogHost = process.env.NEXT_PUBLIC_POSTHOG_HOST;
+
+  if (posthogKey && posthogHost) {
+    posthog.init(posthogKey, {
+      api_host: posthogHost,
+      person_profiles: "always",
+    });
+  } else {
+    console.log(
+      "PostHog environment variables are not set. Analytics will be disabled. Skipping PostHog initialization.",
+    );
+  }
 }
+
 export function CSPostHogProvider({ children }: { children: React.ReactNode }) {
   return <PostHogProvider client={posthog}>{children}</PostHogProvider>;
 }