Skip to content

setup-github-pages.md

Latest commit

 

History

History
93 lines (66 loc) · 2.89 KB

setup-github-pages.md

File metadata and controls

93 lines (66 loc) · 2.89 KB
Raw

GitHub Pages Setup Guide

This guide will help you set up GitHub Pages for the Requirements Tracker project.

Prerequisites

  • A GitHub account
  • The Requirements Tracker repository cloned to your local machine
  • Git configured on your system

Setup Steps

1. Enable GitHub Pages

  1. Go to your repository on GitHub: https://github.com/DRYTRIX/RequirementsTracker
  2. Click on Settings tab
  3. Scroll down to Pages section in the left sidebar
  4. Under Source, select Deploy from a branch
  5. Choose gh-pages branch (this will be created by the GitHub Action)
  6. Click Save

2. Configure GitHub Actions

The repository already includes a GitHub Actions workflow (.github/workflows/deploy.yml) that will automatically deploy your site to GitHub Pages when you push to the main branch.

3. Push Your Changes

# Add all changes
git add .

# Commit the changes
git commit -m "Add GPL 3 license, update README with screenshots, and create GitHub Pages site"

# Push to GitHub
git push origin main

4. Verify Deployment

  1. Go to the Actions tab in your repository
  2. You should see a workflow running called "Deploy to GitHub Pages"
  3. Wait for it to complete (usually takes 2-3 minutes)
  4. Once complete, your site will be available at: https://drytrix.github.io/RequirementsTracker/

Custom Domain (Optional)

If you want to use a custom domain:

  1. In the Pages settings, enter your custom domain
  2. Add a CNAME file to your repository root with your domain name
  3. Configure your DNS provider to point to GitHub Pages

Troubleshooting

Site Not Updating

  • Check the Actions tab to ensure the deployment workflow completed successfully
  • Wait a few minutes for changes to propagate
  • Clear your browser cache

Images Not Loading

  • Ensure all image paths in index.html are relative to the repository root
  • Check that the assets/screenshots/ directory contains all the required images

404 Errors

  • Make sure the .nojekyll file is present in the repository root
  • Verify that index.html is in the repository root

File Structure for GitHub Pages

RequirementsTracker/
├── index.html              # Main landing page
├── .nojekyll              # Disable Jekyll processing
├── LICENSE                # GPL 3 license
├── README.md              # Project documentation
├── assets/
│   └── screenshots/       # Application screenshots
├── .github/
│   └── workflows/
│       └── deploy.yml     # GitHub Actions workflow
└── ... (other project files)

Links

License

This setup guide is part of the Requirements Tracker project and is licensed under the GNU General Public License v3.0.