Skip to content

docs: clarify parallel execution for dev servers in setup#159

Merged
Mananwebdev160408 merged 1 commit into
Mananwebdev160408:mainfrom
Mohit-001-hash:fix-dev-setup-docs
Jul 4, 2026
Merged

docs: clarify parallel execution for dev servers in setup#159
Mananwebdev160408 merged 1 commit into
Mananwebdev160408:mainfrom
Mohit-001-hash:fix-dev-setup-docs

Conversation

@Mohit-001-hash

Copy link
Copy Markdown
Contributor

Summary

This PR improves the developer onboarding experience by clarifying the setup instructions in the README.md. Previously, the commands to start the backend and frontend development servers were listed in a single code block. Because npm run dev is a blocking continuous process, a contributor copying and pasting the whole block would get stuck, and the UI server would never start. I have separated these into explicitly marked terminal instructions so it is clear they need to be run in parallel.

Closes #None


Type of Change

  • Bug fix
  • New feature
  • Refactor (no functional change)
  • Documentation update
  • UI / style improvement
  • Tests
  • Config / CI / tooling

What Was Changed

  • Updated the "Develop from this repository" section in README.md.
  • Separated the npm run dev and npm run dev:ui commands into distinct "Terminal 1" and "Terminal 2" steps.
  • Grouped the build command as an optional step at the end.

How to Test

  1. Open the README.md file.
  2. Navigate to the Installation > Develop from this repository section.
  3. Verify that the markdown clearly delineates running the backend and frontend servers in separate terminal windows.

Checklist

  • My code follows the project's TypeScript conventions
  • npm run lint passes (no TypeScript errors)
  • I have tested my changes locally
  • I have added comments where the code is complex or non-obvious
  • I have updated relevant documentation (if applicable)
  • This PR is linked to an open issue

Screenshots (if UI change)

Before After
N/A N/A

Related Issues / PRs

None

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 28, 2026
@Mananwebdev160408 Mananwebdev160408 merged commit 3fc6e7d into Mananwebdev160408:main Jul 4, 2026
1 check passed
@Mohit-001-hash

Copy link
Copy Markdown
Contributor Author

Can you please add the gssoc approved label without it I won't get gssoc points

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants