Improve developer onboarding: Missing structured guidance for setting up Rocket.Chat development environment

[jituchoudhary367]

Hi, team.

While exploring the Rocket. While working on the chat repository and setting up the project locally, I noticed that the onboarding experience for new contributors could be smoother.

I encountered a few challenges along the way, despite following the available documentation, which could also impact others starting out.

What I found challenging
The setup involves multiple tools (Meteor, Node.js, MongoDB, Yarn), but there isn’t a single clear, step-by-step guide that brings everything together
Some common issues (like dependency errors or native module failures) aren’t documented in one place
It’s not very obvious how to confirm if the setup has been done correctly
Troubleshooting information is spread across different docs/pages
Why this matters

Rocket.Chat has a powerful but fairly complex codebase. For someone new, even getting the app running locally can take a significant amount of time.

Improving this flow could:

Help new contributors get started faster
Reduce repeated setup-related questions/issues
Make onboarding smoother for GSoC participants and first-time contributors
Suggested improvement

It might help to add a simple “Quick Start for Contributors” section in the README or docs that includes:

Recommended versions (Node, Meteor, etc.)
A clean, copy-paste-friendly setup flow
A small troubleshooting section for common issues
A quick way to verify everything is working (e.g., expected output or URL)

If this sounds useful, I’d be happy to help draft or contribute to this section

Thanks!

[coderabbitai]

⚠️ Possible Duplicate Issue(s)

• [Improvement] Local Development Setup Documentation (especially for Windows) #37990

---

📝 Issue Planner

_{Check the box below or use the @coderabbitai plan command to generate an implementation plan and prompts that you can use with your favorite coding assistant.}

• Create Plan

---

🧪 Issue enrichment is currently in open beta.

You can configure auto-planning by selecting labels in the issue_enrichment configuration.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

💬 Have feedback or questions? Drop into our discord!

[KevinCastilloh]

I totally agree with this, I’ve just spent several hours setting up the environment on Windows 10 for my GSoC proposals, I encountered a few challenges mentioned for me to properly set up.

Specifically for Windows users, I found a few gotchas that aren't clearly documented:

Path lengths and spaces, using a folder with spaces (like Desktop/Project GSOC) breaks the build.bat in rocketchat-livechat. Moving the project to C:\Rocket.Chat was the only fix.
I had Errors with @swc/core and argon2, often require manual installation of node-gyp-build and specific rebuilds that aren't in the main README.

Resource Management: For developers with 8GB RAM, the 'Linking' phase is extremely heavy. Documentation on using --max-old-space-size and --exclude-archs would be a lifesaver for contributors with mid-range hardware.

I’d love to contribute my 'Windows Troubleshooting' findings to this new guide if this moves forward. This would definitely help more students from regions with diverse hardware setups to join the community!

[rhodesgarret56-cell]

Hi all, Agreed—this would really improve onboarding. Happy to help draft a quick-start guide with setup steps and common fixes.

…

On Tue, Mar 31, 2026, 10:24 AM Kevin Castillo ***@***.***> wrote: *KevinCastilloh* left a comment (RocketChat/Rocket.Chat#40008) <#40008 (comment)> I totally agree with this, I’ve just spent several hours setting up the environment on Windows 10 for my GSoC proposals, I encountered a few challenges mentioned for me to properly set up. Specifically for Windows users, I found a few gotchas that aren't clearly documented: Path lengths and spaces, using a folder with spaces (like Desktop/Project GSOC) breaks the build.bat in rocketchat-livechat. Moving the project to C:\Rocket.Chat was the only fix. I had Errors with @swc/core and argon2, often require manual installation of node-gyp-build and specific rebuilds that aren't in the main README. Resource Management: For developers with 8GB RAM, the 'Linking' phase is extremely heavy. Documentation on using --max-old-space-size and --exclude-archs would be a lifesaver for contributors with mid-range hardware. I’d love to contribute my 'Windows Troubleshooting' findings to this new guide if this moves forward. This would definitely help more students from regions with diverse hardware setups to join the community! — Reply to this email directly, view it on GitHub <#40008?email_source=notifications&email_token=B7ZXRYAABVV6C762X4RBBLT4TP5LTA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIMJWGQZDCMRVGA22M4TFMFZW63VKON2WE43DOJUWEZLEUVSXMZLOOSWGM33PORSXEX3DNRUWG2Y#issuecomment-4164212505>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/B7ZXRYHKKKL4QZGXCR5EIKL4TP5LTAVCNFSM6AAAAACXHYCY72VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DCNRUGIYTENJQGU> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>