GitHub Pages Deployment Guide#

This project is configured to automatically deploy to GitHub Pages via GitHub Actions.

Setup Instructions#

1. Enable GitHub Pages in Repository Settings#

1. Go to your GitHub repository
2. Navigate to Settings → Pages
3. Under Source, select GitHub Actions

2. Push Your Changes#

Once you push to the main branch, the GitHub Action will automatically:

• Build the project
• Deploy to GitHub Pages

git add .
git commit -m "Add GitHub Pages deployment"
git push origin main

3. Access Your Site#

After the action completes successfully, your site will be available at:

https://<your-username>.github.io/proofery-web/

Manual Deployment#

You can also trigger a deployment manually:

1. Go to Actions tab in your repository
2. Select the Deploy to GitHub Pages workflow
3. Click Run workflow

Configuration#

• Workflow file: .github/workflows/deploy.yml
• Base path: /proofery-web/ (configured in vite.config.ts)
• Build output: dist/ directory

Troubleshooting#

If the deployment fails:

1. Check the Actions tab for error messages
2. Ensure GitHub Pages is enabled in repository settings
3. Verify the repository has the correct permissions set in the workflow
4. Make sure the main branch is the default branch

Local Testing#

To test the production build locally:

npm run build
npm run preview