RocketChat / RocketChat/Rocket.Chat
[Improvement] Local Development Setup Documentation (especially for Windows)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 46.1k
- Forks
- 13.9k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 130
Description
Description:
The current local development setup instructions can be confusing for new contributors, particularly on Windows. Many contributors report difficulties with installing dependencies, resolving build errors, and understanding the correct tooling setup (Node/Yarn/MongoDB/Meteor) when trying to run Rocket.Chat locally.
What could be improved:
-
Add a clear Windows-verified step-by-step setup guide (including versions and required tooling).
-
Add a troubleshooting section for common errors during dependency installation and build steps.
-
Clarify when to use Docker vs native Meteor setup.
-
Include example .env setup and common fixes for build failures.
Why this matters:
A better onboarding experience will reduce setup issues for first-time contributors and improve contributor retention.
I am willing to:
-
Implement documentation changes
-
Test on Windows 10/11
-
Iterate based on maintainer feedback
-
Add screenshots or short gifs if needed
( This is being raised as a clarification / improvement request.
If a detailed and up-to-date contribution guide for local setup (especially for Windows) already exists, please confirm and point to it. )
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing local development and contribution setup documentation, then compare its Node, Yarn, MongoDB, and Meteor instructions with a Windows 10/11 setup. Check both Docker and native Meteor paths, record dependency and build errors, and document verified steps, troubleshooting guidance, and example environment configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- mongodb, node.js
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100