Mac OSX
You can set up and configure a Rocket.Chat development environment on your macOS system running on Apple Silicon or systems with non-Apple Silicon chips.
Apple Silicon
Preparation Steps
Install Yarn
Install Meteor
Install Homebrew
Install the Node Version Manager (nvm) with this command:
Confirm that your nvm version is 0.39.2 or higher by running the command nvm --version
in your terminal.
Setting up a Rocket.Chat Development Environment on MacOS Apple Silicon
Fork the Rocket.Chat repository on GitHub. Clone the forked repository to your local dev box using this command:
Navigate into the project directory and configure an additional remote so we can later fetch updates from the main Rocket.Chat repo with these commands:
Confirm the Node.js version required by your RocketChat version by executing the following command:
Install the required version of NodeJS replacing
x.x.x
with the required NodeJs version number:
Initialize the
meteor
framework. This will show the version of meteor requested by Rocket.Chat (located inapps/meteor/.meteor/release
). It will also initialize the framework.
Install all needed packages and proceed to build the Rocket.Chat app with these commands:
Start your development server.
For systems with 16 GB of memory or higher, use this command:
For systems with less than 16 GB of memory, use
Once it is finished, the following output will be displayed on your terminal and the local server will be running on http://localhost:3000
.
If you encounter any issues, see Troubleshooting.
Setting up a Rocket.Chat Development Environment Non-Apple Silicon Chips
This setup instruction has been tested on MacBook Pro 2015, 8Gig Ram, 512Gb SSD,i5.
Install Meteor by executing this command:
Meteor comes pre-installed with npm and node, confirm the versions by executing this command:
Install Yarn if it's not already on your system. It is the recommended package manager.
Information on the various versions of packages needed can be found in the package.json
To easily manage the node versions on your machine, install the n node package manager and switch to your desired NodeJs version.
Replace x.x.x with the NodeJs version number.
Fork the Rocket.Chat repository on GitHub. Clone the forked repository and navigate to the project directory using this command:
Run the following commands to navigate to the
meteor
directory and download the necessary meteor version for Rocket.Chat, as configured in.meteor/release
file:
Navigate to the project root directory and install all the needed packages by executing this command:
Build and startup your development server by running this command:
Once it is finished, the following output will be displayed on your terminal and the local server will be running on http://localhost:3000
.
You can modify the code in your IDE and see the changes on the server instance. Now, you can start contributing to Rocket.Chat!
Troubleshooting
Last updated