Skip to content

Commit a537548

Browse files
committed
Add GitHub Pages deployment guide and instructions
- Comprehensive deployment documentation with 2 options - Step-by-step instructions for manual and GitHub Actions deployment - Build files ready in apps/web-landing/dist/ - Production app (89 KB gzipped) includes landing, auth, dashboard, and docs https://claude.ai/code/session_01WhokHaRSwyMUdit7mfcgok
1 parent 6b3f55f commit a537548

1 file changed

Lines changed: 150 additions & 0 deletions

File tree

GITHUB_PAGES_DEPLOYMENT.md

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Code Kit Ultra - GitHub Pages Deployment Guide
2+
3+
The Code Kit Ultra web portal is ready for deployment to GitHub Pages!
4+
5+
## Quick Start
6+
7+
### Option 1: Deploy via GitHub Web Interface (Easiest)
8+
9+
1. Go to your GitHub repo: https://github.com/eybersjp/code-kit-ultra
10+
2. Create a new branch called `gh-pages` (if it doesn't exist)
11+
3. Upload the contents of `apps/web-landing/dist/` to the root of the `gh-pages` branch:
12+
- `index.html`
13+
- `assets/` folder with CSS and JS files
14+
15+
4. Go to **Settings → Pages**
16+
5. Under "Build and deployment":
17+
- Source: `Deploy from a branch`
18+
- Branch: `gh-pages`
19+
- Folder: `/ (root)`
20+
- Click **Save**
21+
22+
6. Your site will be live at: **https://eybersjp.github.io/code-kit-ultra/**
23+
24+
---
25+
26+
### Option 2: Use GitHub Actions (Automated)
27+
28+
Create a file: `.github/workflows/deploy-pages.yml`
29+
30+
```yaml
31+
name: Deploy to GitHub Pages
32+
33+
on:
34+
push:
35+
branches: [main]
36+
paths:
37+
- 'apps/web-landing/**'
38+
39+
jobs:
40+
deploy:
41+
runs-on: ubuntu-latest
42+
permissions:
43+
contents: read
44+
pages: write
45+
id-token: write
46+
47+
steps:
48+
- uses: actions/checkout@v3
49+
50+
- uses: pnpm/action-setup@v2
51+
with:
52+
version: 8
53+
54+
- uses: actions/setup-node@v3
55+
with:
56+
node-version: '18'
57+
cache: 'pnpm'
58+
59+
- name: Install dependencies
60+
run: pnpm install --frozen-lockfile
61+
62+
- name: Build web-landing
63+
run: cd apps/web-landing && pnpm build
64+
65+
- name: Setup Pages
66+
uses: actions/configure-pages@v3
67+
68+
- name: Upload artifact
69+
uses: actions/upload-pages-artifact@v2
70+
with:
71+
path: 'apps/web-landing/dist'
72+
73+
- name: Deploy to GitHub Pages
74+
id: deployment
75+
uses: actions/deploy-pages@v2
76+
```
77+
78+
Then in **Settings → Pages**:
79+
- Source: `GitHub Actions`
80+
- Click **Save**
81+
82+
---
83+
84+
## What's Included
85+
86+
The production build (`apps/web-landing/dist/`) contains:
87+
88+
- **index.html** - Main HTML file (0.65 KB)
89+
- **assets/index-*.css** - Styles with dark theme (4.14 KB gzipped)
90+
- **assets/index-*.js** - React app bundle (84.40 KB gzipped)
91+
92+
### Total Size: ~89 KB gzipped
93+
94+
---
95+
96+
## Build Files Location
97+
98+
```
99+
apps/web-landing/dist/
100+
├── index.html
101+
└── assets/
102+
├── index-CJFYl8Q6.css
103+
└── index-CIrub91C.js
104+
```
105+
106+
---
107+
108+
## Features Included
109+
110+
✅ Landing page with features showcase
111+
✅ Signup & Login pages
112+
✅ User dashboard (for token management)
113+
✅ 6-section documentation (Getting Started, API Reference, Governance Rules, Security, Examples, FAQ)
114+
✅ Professional dark theme with brand colors
115+
✅ Responsive design
116+
✅ Copy-to-clipboard code blocks
117+
118+
---
119+
120+
## Important Notes
121+
122+
⚠️ **Backend API Not Included**: The app is frontend-only. To fully enable:
123+
- Signup/Login: Connect to your auth backend (POST `/api/v1/auth/signup`, `/api/v1/auth/login`)
124+
- Token Management: Connect to your API (GET/POST/DELETE `/api/v1/tokens`)
125+
- Projects: Connect to your API (GET `/api/v1/projects`)
126+
127+
For now, the UI is fully functional for exploration and demo purposes.
128+
129+
---
130+
131+
## Steps to Deploy (Summary)
132+
133+
1. Go to GitHub repo Settings → Pages
134+
2. Choose `Deploy from a branch`
135+
3. Create/select `gh-pages` branch
136+
4. Upload contents of `apps/web-landing/dist/` folder
137+
5. Save and wait 1-2 minutes for deployment
138+
6. Access at: `https://eybersjp.github.io/code-kit-ultra/`
139+
140+
---
141+
142+
## Need Help?
143+
144+
The app includes:
145+
- 📖 Comprehensive documentation section
146+
- ❓ FAQ with 15+ answers
147+
- 💡 Real-world examples for CI/CD integration
148+
- 🔒 Security best practices guide
149+
150+
Enjoy! 🚀

0 commit comments

Comments
 (0)