Skip to content

feat: Add deployment improvements and GitHub Pages support #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mno-go wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Add deployment improvements and GitHub Pages support #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,39 @@ npm run build

## GitHub Pages Deployment

### Option 1: Automatic with GitHub Actions (Recommended)

1. Add `OPENAI_API_KEY` to your repository secrets:
- Go to Settings → Secrets and variables → Actions
- Add new repository secret: `OPENAI_API_KEY`

2. Enable GitHub Pages:
- Go to Settings → Pages
- Source: GitHub Actions

3. Push to main branch - deployment happens automatically!

### Option 2: Manual with gh-pages

```bash
# Set environment variables
export VITE_OPENAI_API_KEY="your-openai-api-key"
export GITHUB_PAGES_BASE="/your-repo-name/"

# Build and deploy
npm run build
# Push dist/ to gh-pages branch
npm run deploy
```

### Option 3: Manual build and push

```bash
# Build
export VITE_OPENAI_API_KEY="your-openai-api-key"
export GITHUB_PAGES_BASE="/your-repo-name/"
npm run build

# Push dist/ folder to gh-pages branch manually
```

## Architecture
Expand Down
Loading