Search…
Development Guidelines

Setup

Your development workstation needs to have at least 8GB RAM or more to be able to build the Rocket.Chat's source code.
This project is a mono repo, composed of several sub projects, but the main objective/focus is Rocket.Chat as a single build, so for now all scripts are focused on this result.
We have some restrictions in terms of versions and tooling, please pay attention at this detail.
1
node -v // v14.17.0
2
yarn -v // 3.2.0
Copied!
Rocket.Chat runs on top of Meteor, that is based in Fibers implementation, Fibers only support s node 14.17.0 thats why you will not have success trying a different one.
You need to install Meteor and clone/download the Rocket.Chat's code.
Then you just need run
1
yarn # installs the dependencies for all projects
2
yarn build
3
yarn dev # it will build the sub projects and then run meteor project
Copied!
The code is spread through the folders, packages/ and apps/meteor, the latter contains the vast majority of the project's code.
If everything went well, it should build and run the application and database for you, now you can access the UI on (http://localhost:3000)
You can check more info about mono repo and the tooling we are using here:
Build Your Own Meteor App with our Tutorials!
Meteor documentation
Documentation
Turborepo
Turbo repo documentation
Yarn
Yarn
Yarn workspaces documentation

Coding and Style Guide

Visite the Rocket.Chat developers docs for details on coding and the various style guides.
Code Style Guide
Rocket.Chat Developer
Export as PDF
Copy link