Skip to content

Conversation

@HritikRaj2
Copy link

Closes #66

Summary

This PR addresses the developer onboarding issues identified in #66 by improving the README documentation with comprehensive setup guidance.

Changes Made

1. Expanded Troubleshooting Section

  • Added specific solutions for common build failures
  • Included platform-specific troubleshooting for macOS and Linux
  • Added service-specific debugging steps (port conflicts, MongoDB issues)
  • Documented error messages and their solutions

2. Enhanced Prerequisites Section

  • Added OS-specific installation commands for:
    • Ubuntu/Debian (apt-based)
    • CentOS/RHEL (yum-based)
    • macOS (Homebrew)
  • Added verification commands to confirm successful installation
  • Listed all required software versions explicitly

3. Added Quick Component Reference Table

  • Clear overview of all services with ports and purposes
  • Technology stack information for each component
  • Helps new developers understand the architecture

Impact

✅ New contributors can set up the project on any major OS
✅ Reduces support burden with comprehensive troubleshooting
✅ Faster onboarding with clear component explanations
✅ Fewer setup-related issues and questions

Testing

  • Verified markdown rendering
  • Confirmed all code blocks use correct syntax highlighting
  • Tested table formatting displays correctly

Related Issues

Addresses all documentation concerns raised in #66:

  • ✅ Troubleshooting section for common build failures
  • ✅ Prerequisites for different operating systems
  • ✅ Component explanations
  • ✅ Common build errors and solutions

@HritikRaj2 HritikRaj2 force-pushed the improve-developer-setup branch from 04f4a1b to 5a009a9 Compare December 6, 2025 18:08
@HritikRaj2
Copy link
Author

Hi @axmsoftware @AkarshSahlot! This PR adds troubleshooting guides and OS-specific setup instructions to help new contributors get started faster. Would appreciate your review when you have time. Thanks!

Copy link
Contributor

@axmsoftware axmsoftware left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HritikRaj2 Thank you for the detailed documentation of the PR and the added features for the README.me file!

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.

Create comprehensive developer setup guide.

2 participants