Skip to content

Add frontend development documentation and convenience scripts#23

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/add-dev-scripts-documentation
Draft

Add frontend development documentation and convenience scripts#23
Copilot wants to merge 2 commits intomainfrom
copilot/add-dev-scripts-documentation

Conversation

Copy link

Copilot AI commented Mar 3, 2026

Adds documentation and tooling for running backend (port 5280) and Next.js frontend (port 3000) concurrently during local development.

Changes

  • README.md: New Frontend section with Node 18+ prerequisites, installation (cd src/frontend && npm install), and instructions for running both services via two terminal sessions or Makefile

  • Makefile: Convenience targets for running services independently or concurrently:

    make dev           # Both services with -j2
    make dev-backend   # dotnet run --project src/MythApi.csproj
    make dev-frontend  # cd src/frontend && npm run dev

Frontend assumes backend at http://localhost:5280 for API calls.

Original prompt

This section details on the original issue you should resolve

<issue_title>Add Dev Scripts and Documentation</issue_title>
<issue_description># Step 9: Add Dev Scripts and Documentation

Description

Make it easy for developers to run both the backend and frontend during local development. Update the project README with instructions for the new frontend.

Implementation Steps

  1. Update root README.md — Add a "Frontend" section covering:

    • Prerequisites: Node.js 18+, npm.
    • How to install dependencies: cd src/frontend && npm install.
    • How to run the dev server: cd src/frontend && npm run dev.
    • The frontend URL: http://localhost:3000.
    • The expected backend URL: http://localhost:5280.
    • How to run both services simultaneously (two terminal sessions).
  2. Add a convenience script (optional) — Consider adding a root-level Makefile or package.json with scripts to run both services:

    dev-backend:
    	dotnet run --project src/MythApi.csproj
    
    dev-frontend:
    	cd src/frontend && npm run dev
    
    dev:
    	make -j2 dev-backend dev-frontend
  3. Update src/frontend/package.json — Verify the dev script runs on port 3000 (default). If a custom port is needed, update it:

    "dev": "next dev -p 3000"

Files Modified

  • README.md

Files Optionally Created

  • Makefile (or root package.json)

Acceptance Criteria

  • A new developer can clone the repo and get both services running by following the README.
  • The frontend dev server starts on port 3000.
  • The backend API is accessible from the frontend without CORS errors.
    </issue_description>

Comments on the Issue (you are @copilot in this section)


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: aatmmr <15815012+aatmmr@users.noreply.github.com>
Copilot AI changed the title [WIP] Add dev scripts and update documentation for frontend Add frontend development documentation and convenience scripts Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Dev Scripts and Documentation

2 participants