Fix GitHub Pages deployment: resolve CSS and images not loading issue (#20)

Author: rezwana-karim

.github/workflows/deploy.yml

@@ -41,7 +41,20 @@ jobs:
         run: npm run build:github-pages
 
       - name: Add .nojekyll file
-        run: touch out/.nojekyll
+        run: |
+          echo "Creating .nojekyll file to disable Jekyll processing"
+          touch out/.nojekyll
+          echo "Verifying .nojekyll file was created:"
+          ls -la out/.nojekyll
+
+      - name: Debug build output
+        run: |
+          echo "Build output structure:"
+          ls -la out/
+          echo "Checking _next directory:"
+          ls -la out/_next/
+          echo "Checking static assets:"
+          ls -la out/_next/static/chunks/ | head -5
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

docs/github-pages-deployment.md

@@ -34,18 +34,20 @@ const nextConfig: NextConfig = {
 };
 ```
 
-### 2. GitHub Actions Workflow (`.github/workflows/deploy-github-pages.yml`)
+### 2. GitHub Actions Workflow (`.github/workflows/deploy.yml`)
 
 Automated deployment workflow that:
-- Triggers on pushes to `main` branch
+- Triggers on pushes to `main` branch and pull requests
 - Can be manually triggered via workflow_dispatch
-- Builds the Next.js application as static files
-- Deploys to GitHub Pages
+- Builds the Next.js application as static files using `npm run build:github-pages`
+- Creates `.nojekyll` file to disable Jekyll processing
+- Deploys to GitHub Pages using official GitHub Pages action
 
-### 3. Additional Files
+### 3. Critical Files for Deployment
 
-- `.nojekyll`: Prevents GitHub from processing the site with Jekyll
-- `404.html`: Custom 404 page (automatically generated by Next.js)
+- **`.nojekyll`**: Automatically created during build to prevent GitHub from processing the site with Jekyll (critical for `_next` directory assets)
+- **`404.html`**: Custom 404 page (automatically generated by Next.js)
+- **Asset files**: All CSS/JS files in `_next/static/` directory with correct basePath prefixes
 
 ## Deployment Process