|
| 1 | +# ⚡ Quick Deploy Reference |
| 2 | + |
| 3 | +## 🚀 Deploy in 3 Steps |
| 4 | + |
| 5 | +### Step 1: Choose Deployment Method |
| 6 | + |
| 7 | +**A) One-Click Deploy** (Easiest - 2 minutes) |
| 8 | +``` |
| 9 | +Click: https://vercel.com/new/clone?repository-url=https://github.com/christophernemala/tutorialkit |
| 10 | +``` |
| 11 | + |
| 12 | +**B) CLI Deploy** (Fast - 5 minutes) |
| 13 | +```bash |
| 14 | +npm i -g vercel |
| 15 | +git clone https://github.com/christophernemala/tutorialkit.git |
| 16 | +cd tutorialkit |
| 17 | +vercel --prod |
| 18 | +``` |
| 19 | + |
| 20 | +**C) Automated CI/CD** (Best for teams - 10 minutes setup) |
| 21 | +```bash |
| 22 | +# 1. Add GitHub secrets |
| 23 | +# 2. Push to main |
| 24 | +git push origin main |
| 25 | +``` |
| 26 | + |
| 27 | +--- |
| 28 | + |
| 29 | +## 📋 Required Information |
| 30 | + |
| 31 | +### For Vercel Deployment |
| 32 | +- GitHub account |
| 33 | +- Vercel account (free tier works) |
| 34 | + |
| 35 | +### For CI/CD (Optional) |
| 36 | +- `VERCEL_TOKEN` - [Create here](https://vercel.com/account/tokens) |
| 37 | +- `VERCEL_ORG_ID` - Run `vercel link`, check `.vercel/project.json` |
| 38 | +- `VERCEL_PROJECT_ID` - Run `vercel link`, check `.vercel/project.json` |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +## 🔧 Build Configuration |
| 43 | + |
| 44 | +```json |
| 45 | +{ |
| 46 | + "buildCommand": "pnpm install && pnpm build", |
| 47 | + "outputDirectory": "docs/tutorialkit.dev/dist", |
| 48 | + "installCommand": "pnpm install --frozen-lockfile", |
| 49 | + "nodeVersion": "18.18.0" |
| 50 | +} |
| 51 | +``` |
| 52 | + |
| 53 | +--- |
| 54 | + |
| 55 | +## ✅ Pre-Flight Checklist |
| 56 | + |
| 57 | +- [ ] Node.js 18.18.0+ installed |
| 58 | +- [ ] pnpm 8.15.6 installed |
| 59 | +- [ ] GitHub account connected |
| 60 | +- [ ] Vercel account created |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +## 🎯 What Gets Deployed |
| 65 | + |
| 66 | +``` |
| 67 | +Source: docs/tutorialkit.dev/ |
| 68 | +Output: docs/tutorialkit.dev/dist/ |
| 69 | +URL: https://your-project.vercel.app |
| 70 | +``` |
| 71 | + |
| 72 | +**Features Enabled**: |
| 73 | +- ✅ WebContainer API |
| 74 | +- ✅ HTTPS |
| 75 | +- ✅ CDN |
| 76 | +- ✅ Service Workers |
| 77 | +- ✅ Cross-origin isolation |
| 78 | + |
| 79 | +--- |
| 80 | + |
| 81 | +## 🐛 Quick Troubleshooting |
| 82 | + |
| 83 | +**Build fails?** |
| 84 | +```bash |
| 85 | +NODE_OPTIONS=--max-old-space-size=8192 pnpm build |
| 86 | +``` |
| 87 | + |
| 88 | +**WebContainer not working?** |
| 89 | +```bash |
| 90 | +# Check headers |
| 91 | +curl -I https://your-domain.vercel.app | grep -i "cross-origin" |
| 92 | +``` |
| 93 | + |
| 94 | +**Need help?** |
| 95 | +- [Full Guide](./DEPLOYMENT.md) |
| 96 | +- [Checklist](./PRODUCTION_CHECKLIST.md) |
| 97 | +- [Issues](https://github.com/christophernemala/tutorialkit/issues) |
| 98 | + |
| 99 | +--- |
| 100 | + |
| 101 | +## 📊 Expected Timeline |
| 102 | + |
| 103 | +| Method | Setup Time | Deploy Time | Total | |
| 104 | +|--------|------------|-------------|-------| |
| 105 | +| One-Click | 0 min | 2 min | **2 min** | |
| 106 | +| CLI | 2 min | 3 min | **5 min** | |
| 107 | +| CI/CD | 10 min | 5 min | **15 min** | |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +## 🎉 Success Indicators |
| 112 | + |
| 113 | +After deployment, verify: |
| 114 | +- [ ] Site loads at Vercel URL |
| 115 | +- [ ] HTTPS certificate active |
| 116 | +- [ ] WebContainer initializes |
| 117 | +- [ ] Code editor works |
| 118 | +- [ ] Terminal functional |
| 119 | + |
| 120 | +--- |
| 121 | + |
| 122 | +## 📞 Quick Links |
| 123 | + |
| 124 | +- **Repository**: https://github.com/christophernemala/tutorialkit |
| 125 | +- **Deploy Button**: https://vercel.com/new/clone?repository-url=https://github.com/christophernemala/tutorialkit |
| 126 | +- **Full Docs**: [DEPLOYMENT.md](./DEPLOYMENT.md) |
| 127 | +- **Checklist**: [PRODUCTION_CHECKLIST.md](./PRODUCTION_CHECKLIST.md) |
| 128 | + |
| 129 | +--- |
| 130 | + |
| 131 | +**Status**: ✅ Ready to Deploy |
| 132 | + |
| 133 | +**Last Updated**: 2026-01-29 |
0 commit comments