promptgrade-frontend

PromptGrade Frontend

Next.js frontend for PromptGrade. This app is configured as a static export and is deployed via GitHub Pages.

Stack

• Next.js 14
• React 18
• TypeScript
• Tailwind CSS

Prerequisites

• Node.js 20+
• npm 10+

Environment Variables

Copy .env.example to .env.development:

cp .env.example .env.development

Available variables:

• NEXT_PUBLIC_API_URL: Backend base URL used for API calls (default local backend is http://localhost:8080)
• NEXT_PUBLIC_GA_ID (optional): Google Analytics ID

Local Development

1. Install dependencies:

npm install

1. Run dev server:

npm run dev

1. Open:

http://localhost:3000

Run With Local Backend

Frontend expects the backend at NEXT_PUBLIC_API_URL (for local, usually http://localhost:8080).

If your backend runs on a different port/host, update .env.development:

NEXT_PUBLIC_API_URL=http://localhost:8080

Then restart npm run dev.

Production Build (Static Export)

Build output is exported to out/:

npm run build

Pipeline (GitHub Actions)

Workflow file: .github/workflows/deploy-pages.yml

Current behavior:

• Triggers on pushes to main/master
• Installs with npm ci
• Runs npm run build
• Uploads out/ and deploys to GitHub Pages

GitHub repository variables expected by the workflow:

• NEXT_PUBLIC_API_URL
• NEXT_PUBLIC_GA_ID (optional)
• PAGES_DOMAIN (optional custom domain)

Useful Commands

npm run dev
npm run build
npm run start
npm run lint