Skip to content

Docs: Friday Cleanup: docs across 2 areas#6

Open
moxie-docs[bot] wants to merge 1 commit into
mainfrom
moxie/friday-cleanup-2026-06-26-8d3043
Open

Docs: Friday Cleanup: docs across 2 areas#6
moxie-docs[bot] wants to merge 1 commit into
mainfrom
moxie/friday-cleanup-2026-06-26-8d3043

Conversation

@moxie-docs

@moxie-docs moxie-docs Bot commented Jun 26, 2026

Copy link
Copy Markdown

Covers these changes:

  • Add docs for combined workflow for fullstack not centralized
  • Add docs for Backend server behavior and API surface undocumented

Documents how to run and develop the frontend and backend together from the repo root, and specifies the backend server’s Express API and health endpoint. This helps maintainers quickly spin up the fullstack dev workflow and understand the backend routes, middleware, and port behavior.

What these docs cover

  • Root npm start uses concurrently to run npm run server (nodemon backend/server.js) and npm run client (npm start --prefix frontend) in parallel
  • Development expects frontend at http://localhost:3000 and backend at http://localhost:5000, with cross-origin calls requiring CORS on the backend
  • Frontend has no CRA proxy configured; calls must use fully qualified backend URLs (e.g., http://localhost:5000/...)
  • Backend server.js applies middleware in order: cors() then express.json(), selects PORT from env with default 5000, and starts listening
  • Backend exposes GET /api/project returning static JSON metadata and GET /healthz returning plain text OK
  • backend/package.json declares express and cors dependencies and lacks a start script; server is intended to run via node or the root scripts

How to review

  • Verify root package.json scripts: start is concurrently "npm run server" "npm run client", server is nodemon backend/server.js, and client is npm start --prefix frontend
  • Check backend/server.js sets const PORT = process.env.PORT || 5000 and logs Server running on port ${PORT} in app.listen
  • Confirm backend/server.js registers app.use(cors()) before app.use(express.json())
  • Verify backend/server.js defines GET /api/project that responds with JSON fields studentName, projectName, projectUrl, projectDescription with the values shown in the doc
  • Confirm backend/server.js defines GET /healthz that responds with res.send('OK')
  • Ensure backend/package.json lists dependencies express@^4.21.1 and cors@^2.8.5 and no start script is present
  • Compare README.md to ensure it documents starting with npm start and shows frontend at http://localhost:3000 and backend at http://localhost:5000, plus the example fetch to http://localhost:5000/api/project

Documentation updated

Referenced sources

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.

0 participants