Gaining a deep understanding of Rocket.Chat’s server repository structure is a foundational requirement for developers. The Rocket.Chat server's architectural design prioritizes modularity and clarity, reflected in the repository structure, segregating functions for diverse developer levels.
Rocket.Chat uses a monorepo to house essential code and packages required by various Rocket.Chat projects, such as the Apps-Engine and Livechat. This makes maintaining and sharing the code easier and allows developers to work on different projects simultaneously.
Rocket.Chat builds its components using the Meteor framework and React. To understand the Rocket.Chat repository structure, you should be familiar with the Meteor and React project structures.
In the near future, Rocket.Chat will move away from Meteor to a more manual structure, which will allow it to be more flexible and scalable.
This document helps you navigate and understand the server’s components, directories, functionalities, and organizational principles.
Directory structure
Rocket.Chat
├── README.md
├── _templates/
├── apps/
│ └── meteor/
│ ├── app/ # Features of Rocket.Chat
│ ├── client/ # General frontend only related code
│ ├── definition/
│ ├── ee/ # Enterprise related code
│ ├── imports/
│ ├── install.sh*
│ ├── lib/ # Helper functions, classes, and methods
│ ├── package.json
│ ├── packages/ # Meteor packages customized in use
│ ├── private/ # Private files and assets only available within the project
│ ├── public/ # Publicly available files served directly from the project root
│ ├── server/ # Server side only code
│ ├── tests/ # Tests
├── ee/
│ └── apps/
├── package.json
├── packages/ # Houses sharable code that can be used by different projects
│ ├── agenda/
│ ├── api-client/
│ ├── cas-validate/
│ ├── core-typings/ # Type definitions used for core Rocket.Chat
│ │ ├── src/
│ ├── eslint-config/ # Config files and rules for code and unit tests
│ │ ├── best-practices/
│ │ ├── errors/
│ │ ├── ...
│ │ └── variables/
│ ├── livechat/
│ ├── model-typings/
│ ├── models/
│ ├── rest-typings/ # Signatures of endpoints
│ ├── ui-client/
│ ├── ui-contexts/
│ └── ui-video-conf/apps/meteor/app/: This directory shows the various features Rocket.Chat offers. Each primary folder here contains aclient/andserver/subdirectory, housing feature-specific code for the feature, respectively. Occasionally, alib/directory contains code usable by both the app's server and client.
To learn more, see the Meteor guide.
Rocket.Chat is incorporating new features that won't adhere to the legacy Meteor structure within the
apps/directory. These new features will adopt a distinct structure, while the existing code structure will continue to be mantained.
apps/meteor/client/views/: Every Rocket.Chat page a client-side user interacts with is a result of multiple components working together. A good starting point for beginners to see how this works is theapps/meteor/client/views/directory, which contains all of the views for Rocket.Chat. The root view of Rocket.Chat is the first file that is executed when a user opens Rocket.Chat in their web browser can be found atapps/meteor/client/views/root/AppRoot.tsx.apps/meteor/client/lib/: This is a collection of objects that are reused on all client sides. This exists to limit code duplication, encourage contributors to use the code already in the codebase, and avoid re-implementing logic or re-creating functions.apps/meteor/packages/: This directory houses any meteor packages used in the project or customized for a specific purpose. Notable examples include the meteor-accounts-linkedin for LinkedIn login service, rocketchat-i18n for internationalization, etc.apps/meteor/server/methods/: This directory contains all meteor methodsapps/meteor/server/lib/: This directory holds versatile functions related to server-side code.
Now that you are familiar with the repository structure, you can confidently continue with your server environment setup.