Skip to content

Commit 3261fda

Browse files
committed
Add explanation why GitHub Pages cannot be used and guide to deploy on Vercel instead
1 parent 91b1c86 commit 3261fda

1 file changed

Lines changed: 136 additions & 0 deletions

File tree

GITHUB-PAGES.md

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# ⚠️ GitHub Pages Limitation
2+
3+
## Why This App Can't Use GitHub Pages
4+
5+
GitHub Pages only hosts **static HTML/CSS/JS files**. Your Giga Coder app requires:
6+
7+
**Server-side API routes** (for AI generation)
8+
**Database connections** (PostgreSQL)
9+
**Real-time streaming** (for code generation)
10+
**Environment variables** (API keys)
11+
**Server-side rendering** (Next.js App Router)
12+
13+
## ✅ Solution: Deploy to Vercel (FREE & Better!)
14+
15+
Vercel is made by the creators of Next.js and is **FREE** for personal projects.
16+
17+
### Quick Deploy (3 minutes):
18+
19+
#### Step 1: Go to Vercel
20+
Visit: **https://vercel.com/new**
21+
22+
#### Step 2: Sign in with GitHub
23+
- Click "Continue with GitHub"
24+
- Authorize Vercel
25+
26+
#### Step 3: Import Your Repository
27+
- Click "Import Git Repository"
28+
- Search for: `Giga-Coder`
29+
- Click "Import"
30+
31+
#### Step 4: Configure (Auto-detected!)
32+
Vercel automatically detects:
33+
- ✅ Framework: Next.js
34+
- ✅ Build Command: `pnpm run build`
35+
- ✅ Output Directory: `.next`
36+
- ✅ Install Command: `pnpm install`
37+
38+
#### Step 5: Add Environment Variables
39+
Click "Environment Variables" and add these:
40+
41+
```env
42+
TOGETHER_API_KEY=your_together_api_key
43+
DATABASE_URL=your_neon_database_url
44+
CSB_API_KEY=your_codesandbox_api_key
45+
```
46+
47+
**Get your API keys:**
48+
- TOGETHER_API_KEY: https://api.together.xyz
49+
- DATABASE_URL: https://neon.tech
50+
- CSB_API_KEY: https://codesandbox.io
51+
52+
#### Step 6: Deploy!
53+
- Click "Deploy"
54+
- Wait 2-3 minutes
55+
- Your app is LIVE! 🎉
56+
57+
### Your App Will Be Available At:
58+
```
59+
https://giga-coder.vercel.app
60+
```
61+
62+
### Auto-Deploy on Push
63+
Every time you push to GitHub, Vercel automatically deploys! 🚀
64+
65+
```bash
66+
git add .
67+
git commit -m "New feature"
68+
git push
69+
# Vercel auto-deploys! ✨
70+
```
71+
72+
---
73+
74+
## 🆚 Comparison
75+
76+
| Feature | GitHub Pages | Vercel |
77+
|---------|-------------|---------|
78+
| **Cost** | Free | Free |
79+
| **Static Sites** | ✅ Yes | ✅ Yes |
80+
| **Server APIs** | ❌ No | ✅ Yes |
81+
| **Database** | ❌ No | ✅ Yes |
82+
| **Next.js** | ❌ Limited | ✅ Perfect |
83+
| **Environment Variables** | ❌ No | ✅ Yes |
84+
| **Custom Domains** | ✅ Yes | ✅ Yes |
85+
| **HTTPS** | ✅ Yes | ✅ Yes |
86+
| **Deploy Speed** | Medium | Fast |
87+
| **Auto-Deploy** | Manual | ✅ Automatic |
88+
89+
---
90+
91+
## 🚀 Deploy Now!
92+
93+
**Click here to deploy:**
94+
95+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/yesh00008/Giga-Coder)
96+
97+
Or visit: https://vercel.com/new
98+
99+
---
100+
101+
## Alternative Deployment Options
102+
103+
If you prefer not to use Vercel:
104+
105+
### 1. **Netlify** (Free)
106+
- Visit: https://netlify.com
107+
- Connect GitHub repository
108+
- Add environment variables
109+
- Deploy
110+
111+
### 2. **Railway** (Free tier)
112+
- Visit: https://railway.app
113+
- Connect GitHub
114+
- Auto-deploys
115+
116+
### 3. **Render** (Free tier)
117+
- Visit: https://render.com
118+
- Connect repository
119+
- Deploy
120+
121+
---
122+
123+
## 📞 Need Help?
124+
125+
1. Read: [DEPLOY.md](./DEPLOY.md) - Detailed deployment guide
126+
2. Read: [DEPLOYMENT-GUIDE.md](./DEPLOYMENT-GUIDE.md) - Step-by-step Vercel guide
127+
3. GitHub Issues: https://github.com/yesh00008/Giga-Coder/issues
128+
129+
---
130+
131+
## 🎯 Summary
132+
133+
**❌ Don't use:** GitHub Pages (won't work)
134+
**✅ Use instead:** Vercel (free, easy, perfect for Next.js)
135+
136+
**Deploy now:** https://vercel.com/new 🚀

0 commit comments

Comments
 (0)