Contribute to Apps-Engine
Being open source, we always welcome contributors to help us develop the ultimate chat platform. Contribute to our open source Apps-Engine framework, increasing the world of possibilities of integrations around the Rocket.Chat ecosystem. You can check out our Apps-Engine repository here.
An excellent place to start looking at is our open issues and determining if you can help us with them.
When developing new functionalities, you need to integrate the local version of the Apps-Engine with your local version of Rocket.Chat.
Get the Apps-Engine code
To start, clone the Apps-Engine repository and navigate into the directory by running the following commands:
Next, install all the required packages and compile the changes since that is what Rocket.Chat itself will execute.
Setup your Rocket.Chat environment following the guide on:
https://github.com/RocketChat/developer-docs/blob/master/rocket.chat/rocket.chat-server
After setting up, go to the directory and run the following command:
Here PATH_TO_APPS_ENGINE
is the path to the Apps-Engine repo you cloned earlier.
You can now start your Rocket.Chat with the
meteor
command, it will use your local Apps-Engine instead of the one on NPM.
Whenever you make changes to the engine, run npm run compile
again - meteor will take care of restarting the server due to the changes.
Troubleshooting Apps-Engine development
Sometimes, when you update the Apps-Engine code and compile it while Rocket.Chat is running; you run into errors similar to these:
Restart the meteor process, and it should be fixed.
Sometimes using
meteor npm install PATH_TO_APPS_ENGINE
causes the following error:
Here PATH_TO_ROCKETCHAT
is the path to the main Rocket.Chat server repo in your system. To fix this, we reinstall the package once again and delete the previous package.
Last updated