Relevant source files

The following files were used as context for generating this wiki page: - [README.md](https://github.com/RocketChat/Rocket.Chat/blob/main/README.md) - [package.json](https://github.com/RocketChat/Rocket.Chat/blob/main/package.json) - [packages/apps-engine/README.md](https://github.com/RocketChat/Rocket.Chat/blob/main/packages/apps-engine/README.md) - [apps/meteor/app/irc/README.md](https://github.com/RocketChat/Rocket.Chat/blob/main/apps/meteor/app/irc/README.md) - [apps/meteor/package.json](https://github.com/RocketChat/Rocket.Chat/blob/main/apps/meteor/package.json) - [packages/fuselage-ui-kit/README.md](https://github.com/RocketChat/Rocket.Chat/blob/main/packages/fuselage-ui-kit/README.md) - [packages/ui-kit/README.md](https://github.com/RocketChat/Rocket.Chat/blob/main/packages/ui-kit/README.md)

# Developer Guide: Setting up the Environment This guide provides instructions for setting up a local development environment for the Rocket.Chat platform. Rocket.Chat is a monorepo project built with TypeScript, utilizing Meteor for its core server application and providing a separate framework, the Apps-Engine, for developing extensions. This document covers the necessary prerequisites, project structure, and workflows for developing the core server, UI components, and Rocket.Chat Apps. The setup process involves cloning the repository, installing dependencies using Yarn, and running various scripts to build and launch the different parts of the application. Developers can work on the main Meteor server, develop UI components in isolation using Storybook, or build and test new functionalities for the Apps-Engine. ## Prerequisites Before you begin, ensure you have the following tools installed on your system. The specific versions are enforced by the project configuration. | Tool | Required Version | Source - - - | | Node.js | 22.16.0 | `Sources: [package.json:96-98]()` - - | | Yarn | 4.11.0 | `Sources: [package.json:96-98]()` - - - | | Meteor | Not specified | `Sources: [apps/meteor/app/irc/README.md:27]()` - - | - `mongoDB` | Not specified | `Sources: [apps/meteor/app/irc/README.md:28]()` - - | *Sources: [package.json:96-98](), [apps/meteor/app/irc/README.md:26-28]()* ## Project Structure Rocket.Chat is a monorepo managed with Yarn Workspaces and Turbo. The project is divided into several directories, each containing specific parts of the ecosystem. ```json "workspaces": [ "apps/*", "packages/*", "ee/apps/*", "ee/packages/*", "apps/meteor/ee/server/services" ] ``` *Sources: [package.json:16-22]()* This diagram illustrates the high-level structure of the monorepo: ```mermaid graph TD A[Rocket.Chat Monorepo] --> B(apps); A --> C(packages); A --> D(ee); B --> B1(meteor); C --> C1(apps-engine); C --> C2(fuselage-ui-kit); C --> C3(ui-kit); D --> D1(ee/apps); D --> D2(ee/packages); ``` *Sources: [package.json:16-22]()* - **`apps/`**: Contains the main applications, with `apps/meteor` being the core Rocket.Chat server. - **`packages/`**: Holds shared libraries and modules, such as the UI component library (`fuselage-ui-kit`) and the `apps-engine`. - **`ee/`**: Contains the enterprise edition code, which extends the community version with additional features. ## Core Server Setup (Meteor) The main Rocket.Chat application is built on the Meteor framework. The following steps outline how to get the server running locally for development. 1. **Clone the Repository**: ```sh git clone https://github.com/RocketChat/Rocket.Chat.git cd Rocket.Chat ``` *Sources: [apps/meteor/app/irc/README.md:31]()* 2. **Install Dependencies**: The project uses Yarn as its package manager. ```sh yarn ``` This command will install all dependencies for all workspaces in the monorepo. 3. **Set Environment Variables**: Before running the server, you must export necessary environment variables. ```sh export ROOT_URL=http://localhost:3000 export MONGO_URL=mongodb://localhost:27017/rocketchat export PORT=3000 ``` *Sources: [apps/meteor/app/irc/README.md:39-43]()* 4. **Start the Development Server**: Use the `dev` script, which leverages Turbo to run the Meteor app in development mode. ```sh yarn dev ``` *Sources: [package.json:25]()* This process is visualized in the following flowchart: ```mermaid flowchart TD A[Clone Repository] --> B[Install Dependencies with Yarn]; B --> C[Set Environment Variables
ROOT_URL, MONGO_URL, PORT]; C --> D[Run 'yarn dev']; D --> E{Server Running?}; E -- Yes --> F[Access at http://localhost:3000]; E -- No --> G[Troubleshoot Meteor/Mongo issues]; ``` *Sources: [package.json:25](), [apps/meteor/app/irc/README.md:31-47]()* Once the server starts successfully, you can access your local Rocket.Chat instance at `http://localhost:3000`. ## Apps-Engine Development The Apps-Engine is a framework that allows developers to build and install apps that extend Rocket.Chat's functionality. To develop for the Apps-Engine, you need to link your local engine code to your local Rocket.Chat server instance. ### Setup Flow The following diagram shows the workflow for setting up the Apps-Engine development environment. ```mermaid flowchart TD subgraph Apps-Engine Repo A[Clone Apps-Engine] B[Run 'npm install'] C[Run 'npm run compile'] end subgraph Rocket.Chat Repo D[Clone Rocket.Chat] E[Run 'yarn'] F[Link local Apps-Engine] end A --> B --> C D --> E C --> F E --> F F --> G[Run 'yarn dev' in Rocket.Chat repo] G --> H[Local RC server uses local Apps-Engine] ``` *Sources: [packages/apps-engine/README.md:21-40]()* ### Detailed Steps 1. **Prepare the Apps-Engine**: In your local clone of the Apps-Engine repository, install dependencies and compile the TypeScript source. ```sh npm install npm run compile ``` *Sources: [packages/apps-engine/README.md:25-26]()* 2. **Link to Rocket.Chat**: From the root of your Rocket.Chat repository, run the following command to link your local Apps-Engine. ```sh meteor npm install PATH_TO_APPS_ENGINE ``` Replace `PATH_TO_APPS_ENGINE` with the actual path to your local Apps-Engine directory. *Sources: [packages/apps-engine/README.md:35]()* 3. **Run Rocket.Chat**: Start the Rocket.Chat server. It will now use your local version of the Apps-Engine. ```sh yarn dev ``` *Sources: [package.json:25]()* Whenever you make changes to the Apps-Engine, you must re-run `npm run compile` in the Apps-Engine directory. The Meteor server will automatically restart to apply the changes. *Sources: [packages/apps-engine/README.md:42-43]()* ## UI & Component Development Rocket.Chat uses Storybook for developing and showcasing UI components in isolation. The primary UI component libraries are `@rocket.chat/fuselage` and `@rocket.chat/fuselage-ui-kit`. To work on UI components: 1. **Build Monorepo Dependencies**: Ensure all packages are built. ```sh yarn build ``` *Sources: [packages/fuselage-ui-kit/README.md:43]()* 2. **Run Storybook**: Navigate to a specific UI package and start its Storybook instance. For example, for `fuselage-ui-kit`: ```sh cd packages/fuselage-ui-kit yarn storybook ``` *Sources: [packages/fuselage-ui-kit/README.md:61]()* This will launch a Storybook server, typically on `http://localhost:6006`, where you can view and interact with the components. ## Key Development Scripts The root `package.json` and individual package files define several scripts to aid in development. | Script | Description | Source File | |--------------|-----------------------------------------------------------------------------|-----------------------------| | `dev` | Starts the main Meteor application in development mode using Turbo. | `package.json` | | `build` | Builds all workspaces in the monorepo using Turbo. | `package.json` | | `lint` | Runs the linter across all workspaces. | `package.json` | | `testunit` | Runs unit tests across all workspaces. | `package.json` | | `storybook` | Starts the Storybook server for UI component development. | `apps/meteor/package.json` | | `compile` | (In Apps-Engine) Compiles the engine's TypeScript code to JavaScript. | `packages/apps-engine/README.md` | *Sources: [package.json:23-30](), [apps/meteor/package.json:29](), [packages/apps-engine/README.md:26]()* ## Conclusion Setting up a development environment for Rocket.Chat involves understanding its monorepo structure and the specific workflows for its different parts. The core server is a Meteor application, extensions are built using the Apps-Engine, and UI components are managed with Fuselage and Storybook. By using the provided `yarn` scripts and following the setup procedures for each part of the ecosystem, developers can efficiently contribute to the platform. Always refer to the `README.md` files within specific packages for more detailed, context-specific instructions. *Sources: [README.md](), [packages/apps-engine/README.md](), [packages/fuselage-ui-kit/README.md]()*## FULL FILE CONTEXT SUMMARY Query: You are an expert code analyst examining the github repository: https://github.com/RocketChat/Rocket.Chat (Rocket.Chat). You provide direct, concise, and accurate information about code repositories. You NEVER start responses with markdown headers or code fences. IMPORTANT:You MUST respond in English language. Total Files Included: 23 Total Files Skipped: 0 Total Context Tokens: 60,312 / 800,000 (7.5%) Remaining Token Budget: 739,688 ### Included Files: 1. packages/apps-engine/README.md (1,464 tokens) 2. README.md (2,052 tokens) 3. packages/fuselage-ui-kit/README.md (886 tokens) 4. packages/ui-kit/README.md (587 tokens) 5. packages/apps-engine/package.json (1,297 tokens) 6. package.json (1,037 tokens) 7. packages/apps-engine/src/definition/app-schema.json (778 tokens) 8. ee/packages/federation-matrix/src/helpers/message.parsers.spec.ts (28,645 tokens) 9. apps/meteor/app/irc/README.md (641 tokens) 10. packages/apps-engine/typedoc.json (68 tokens) 11. packages/message-parser/tests/url.test.ts (2,893 tokens) 12. apps/meteor/client/views/marketplace/AppDetailsPage/tabs/AppDetails/AppDetails.tsx (1,250 tokens) 13. ee/packages/ui-theming/CHANGELOG.md (1,367 tokens) 14. packages/fuselage-ui-kit/package.json (1,340 tokens) 15. apps/meteor/package.json (6,805 tokens) 16. packages/livechat/README.md (899 tokens) 17. packages/peggy-loader/README.md (600 tokens) 18. apps/meteor/client/lib/links.ts (939 tokens) 19. packages/ui-client/src/lib/links.ts (900 tokens) 20. apps/meteor/client/components/MarkdownText.spec.tsx (4,173 tokens) ... and 3 more files ================================================================================ FILE: packages/apps-engine/README.md Relevance Score: 0.990 | Chunks Retrieved: 1 | Tokens: 1,464 ================================================================================ ## Thoughts While Working (for docs) - Apps which don't provide a valid uuid4 id will be assigned one, but this is not recommended and your App should provide an id - The language strings are only done on the clients (`TAPi18next.addResourceBundle(lang, projectName, translations);`) - The implementer of this should restrict the server setting access and environmental variables. Idea is to allow the implementer to have a default set of restricted ones while letting the admin/owner of the server to restrict it even further or lift the restriction on some more. Simple interface with settings and checkbox to allow/disallow them. :thinking: ## What does the Apps-Engine enable you to do? The Apps-Engine is Rocket.Chat's _plugin framework_ - it provides the APIs for Rocket.Chat Apps to interact with the host system. Currently, a Rocket.Chat App can: - Listen to message events - before/after sent - before/after updated - before/after deleted - Listen to room events - before/after created - before/after deleted - Send messages to users and livechat visitors - Register new slash commands - Register new HTTP endpoints Some features the Engine allows Apps to use: - Key-Value Storage system - App specific settings ## Development environment with Rocket.Chat When developing new functionalities, you need to integrate the local version of the Apps-Engine with your local version of Rocket.Chat. First of all, make sure you've installed all required packages and compiled the changes you've made to the Apps-Engine, since that is what Rocket.Chat will execute: ```sh npm install npm run compile ``` Now, you need to setup a local Rocket.Chat server, [so head to the project's README for instructions on getting started](https://github.com/RocketChat/Rocket.Chat#development) (if you haven't already). Make sure to actually clone the repo, since you will probably need to add some code to it in order to make your new functionality work. After that, `cd` into Rocket.Chat folder and run: ```sh meteor npm install PATH_TO_APPS_ENGINE ``` Where `PATH_TO_APPS_ENGINE` is the path to the Apps-Engine repo you've cloned. That's it! Now when you start 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 1. Sometimes, when you update the Apps-Engine code and compile it while Rocket.Chat is running, you might run on errors similar to these: ``` Unable to resolve some modules: "@rocket.chat/apps-engine/definition/AppStatus" in /Users/dev/rocket.chat/Rocket.Chat/app/apps/client/admin/helpers.js (web.browser) If you notice problems related to these missing modules, consider running: meteor npm install --save @rocket.chat/apps-engine ``` Simply restart the meteor process and it should be fixed. 2. Sometimes when using `meteor npm install PATH_TO_APPS_ENGINE` will cause the following error :- ``` npm ERR! code ENOENT npm ERR! syscall rename npm ERR! path PATH_TO_ROCKETCHAT/node_modules/.staging/@rocket.chat/apps-engine-c7135600/node_modules/@babel/code-frame npm ERR! dest PATH_TO_ROCKETCHAT/node_modules/.staging/@babel/code-frame-f3697825 npm ERR! errno -2 npm ERR! enoent ENOENT: no such file or directory, rename 'PATH_TO_ROCKETCHAT/node_modules/.staging/@rocket.chat/apps-engine-c7135600/node_modules/@babel/code-frame' -> 'PATH_TO_ROCKETCHAT/node_modules/.staging/@babel/code-frame-f3697825' npm ERR! enoent This is related to npm not being able to find a file. npm ERR! enoent ``` Here `PATH_TO_ROCKETCHAT` is the path to the main rocketchat server repo in your system To correct this we reinstall the package once again deleting the previous package ``` ~/Rocket.Chat$ rm -rf node_modules/@rocket.chat/apps-engine ~/Rocket.Chat$ cd PATH_TO_APP_ENGINE ~/Rocket.Chat.Apps-engine$ npm install ~/Rocket.Chat.Apps-engine$ cd PATH_TO_ROCKETCHAT ~/Rocket.Chat$ meteor npm install ../Rocket.Chat.Apps-engine ``` ## Implementer Needs to Implement: - `src/server/storage/AppStorage` - `src/server/storage/AppLogStorage` - `src/server/bridges/*` ## Testing Framework: Makes great usage of TypeScript and decorators: https://github.com/alsatian-test/alsatian/wiki * To run the tests do: `npm run unit-tests` * To generate the coverage information: `npm run check-coverage` * To view the coverage: `npm run view-coverage` # Rocket.Chat Apps TypeScript Definitions ## Handlers Handlers are essentially "listeners" for different events, except there are various ways to handle an event. When something happens there is `pre` and `post` handlers. The set of `pre` handlers happens before the event is finalized. The set of `post` handlers happens after the event is finalized. With that said, the rule of thumb is that if you are going to modify, extend, or change the data backing the event then that should be done in the `pre` handlers. If you are simply wanting to listen for when something happens and not modify anything, then the `post` is the way to go. The order in which they happen is: * Pre**Event**Prevent * Pre**Event**Extend * Pre**Event**Modify * Post**Event** Here is an explanation of what each of them means: * **Prevent**: This is ran to determine whether the event should be prevented or not. * **Extend**: This is ran to allow extending the data without being destructive of the data (adding an attachment to a message for example). * **Modify**: This is ran and allows for destructive changes to the data (change any and everything). * Post**Event**: Is mostly for simple listening and no changes can be made to the data. ## Generating/Updating Documentation To update or generate the documentation, please commit your changes first and then in a second commit provide the updated documentation. # Engage with us ## Share your story We’d love to hear about [your experience](https://survey.zohopublic.com/zs/e4BUFG) and potentially feature it on our [Blog](https://rocket.chat/case-studies/?utm_source=github&utm_medium=readme&utm_campaign=community). ## Subscribe for Updates Once a month our marketing team releases an email update with news about product releases, company related topics, events and use cases. [Sign Up!](https://rocket.chat/newsletter/?utm_source=github&utm_medium=readme&utm_campaign=community) ================================================================================ ================================================================================ FILE: README.md Relevance Score: 0.980 | Chunks Retrieved: 2 | Tokens: 2,052 ================================================================================

The ultimate secure open-source solution for team communications

Codecov branch

[Rocket.Chat](https://rocket.chat) is an open-source, secure, fully customizable communications platform developed in TypeScript for organizations with high standards of data protection. We are the ultimate solution for team communications, enabling real-time conversations between colleagues, with other companies, and with your customers or citizens, regardless of how they connect with you. The result is an increase in productivity and user satisfaction rates. Every day, tens of millions of users in over 150 countries and in organizations such as Deutsche Bahn, The US Navy, and Credit Suisse trust Rocket.Chat to keep their communications completely private and secure. # 🚀 Platform overview Rocket.Chat provides endless possibilities. Here’s an overview of the features you benefit from: 💬 [**Team collaboration**](https://docs.rocket.chat/docs/collaborate-using-rocketchat): A single point for secure internal and cross-company collaboration with role-based access control. 🎯 [**Omnichannel citizen engagement**](https://docs.rocket.chat/docs/omnichannel): Seamless digital interactions with your citizens and customers across platforms like WhatsApp, SMS, and more. 🦾 [**Optimization**](https://docs.rocket.chat/docs/optimize-your-workspace): Enhance productivity with self-hosted AI and a customizable and accessible workspace. 🤖 [**Extend and integrate**](https://docs.rocket.chat/docs/extend-and-integrate-rocketchat-capabilities): Install and use public apps from the Rocket.Chat Marketplace, build your own apps, and embed the workspace into your platform.

# 💻 Deploy Rocket.Chat We support different methods of deployment for different needs. Choose your method: - Are you deploying Rocket.Chat on your own servers? You can deploy using one of the recommended methods: Docker, Podman, or Kubernetes. Refer to the [Deployment Guide](https://docs.rocket.chat/docs/deploy-rocketchat) for details. Before you deploy, make sure to check the [system requirements](https://docs.rocket.chat/docs/system-requirements) to deploy a workspace successfully. Alternatively, deploy Rocket.Chat using [Launchpad](https://docs.rocket.chat/docs/deploy-with-launchpad) for a quick and straightforward Kubernetes setup where you don't have to manage each dependency. - Do you need to run the workspace on an isolated network? Set up an [air-gapped workspace](https://docs.rocket.chat/docs/rocketchat-air-gapped-deployment) to use Rocket.Chat without internet access, suitable for high-security or regulated environments. - Looking for a custom cloud-hosted solution without handling infrastructure? Check out our premium, dedicated [cloud hosting options](https://docs.rocket.chat/docs/rocketchat-cloud-hosting-service-level-agreement-sla) that adapt to your needs. - Interested in decentralized communication? Enable [federation](https://docs.rocket.chat/docs/rocketchat-native-federation) to securely communicate and share resources across a federated network. # 📱 Desktop and mobile apps In addition to the web app, you can also download the Rocket.Chat mobile app: [![Rocket.Chat on Apple App Store](https://user-images.githubusercontent.com/551004/29770691-a2082ff4-8bc6-11e7-89a6-964cd405ea8e.png)](https://itunes.apple.com/us/app/rocket-chat/id1148741252?mt=8) [![Rocket.Chat on Google Play](https://user-images.githubusercontent.com/551004/29770692-a20975c6-8bc6-11e7-8ab0-1cde275496e0.png)](https://play.google.com/store/apps/details?id=chat.rocket.android) Download the desktop app: - [Download on the Mac App Store](https://apps.apple.com/us/app/rocket-chat/id1086818840?mt=12) - [Install from the Windows Store](https://apps.microsoft.com/detail/9nblggh52jv6?hl=en-us&gl=NG&ocid=pdpshare) - [Get from Snapcraft for Linux](https://snapcraft.io/rocketchat-desktop) or use the command `sudo snap install rocketchat-desktop` Refer to the [Installation guide](https://docs.rocket.chat/docs/desktop-mobile-apps) for further details. # 📖 Rocket.Chat documentation - [User documentation](https://docs.rocket.chat/docs/rocketchat) - [Administrator's guide](https://docs.rocket.chat/docs/administrators-guide) - [Developer documentation](https://developer.rocket.chat/docs/rocketchat-developer) - [API documentation](https://developer.rocket.chat/apidocs) - [YouTube Rocket.Chat Learning Center](https://www.youtube.com/playlist?list=PLee3gqXJQrFVXnNs5GiuoTMy269ydvcOB) # 🛡️ Trust and compliance The architecture of Rocket.Chat is designed to protect sensitive data, enforce rigorous compliance, and ensure secure, reliable communications for governments, defense, and critical infrastructure organizations operating in high-stakes environments. - **[Trust Center](https://trust.rocket.chat/)**: The Trust Center provides a comprehensive view of how we protect data and maintain transparency. You will find details on our security practices, privacy commitments, compliance certifications, and governance policies. - **[Compliance Center](https://docs.rocket.chat/docs/compliance-center)**: Explore the Compliance Center for additional information on how we commit to providing modern collaboration while protecting sensitive data. # 🛠️ Additional resources for developers You can set up a Rocket.Chat development environment by following the guides below: - **[Server](https://developer.rocket.chat/docs/server)**: See how to set up a Rocket.Chat server development environment on Linux distributions, Windows, Mac, and Gitpod. - **[Desktop](https://developer.rocket.chat/docs/desktop-app)**: Learn how to set up and customize a desktop development environment. You can follow and contribute to the [Rocket.Chat.Electron](https://github.com/RocketChat/Rocket.Chat.Electron) repository. - **[Mobile](https://developer.rocket.chat/docs/mobile-app)**: Learn about mobile app development and configuring push notifications. You can follow and contribute to the [Rocket.Chat.ReactNative](https://github.com/RocketChat/Rocket.Chat.ReactNative) repository. # 🧩 Apps-Engine Develop your own apps that can be integrated with Rocket.Chat. We provide an [open-source Apps-Engine framework](https://developer.rocket.chat/docs/rocketchat-apps-engine) which expands the integration possibilities within the Rocket.Chat ecosystem. # 🆕 Feature request [Rocket.Chat/feature-requests](https://github.com/RocketChat/feature-requests) is used to track Rocket.Chat feature requests and discussions. Click [here](https://github.com/RocketChat/feature-requests/issues/new?template=feature_request.md) to open a new feature request. [Feature Request Forums](https://forums.rocket.chat/c/feature-requests/8) stores the historical archives of old feature requests (up to 2018). # 🤝 Community Join thousands of members worldwide in our [community server](https://open.rocket.chat). Join [#support](https://open.rocket.chat/channel/support) and [#general](https://open.rocket.chat/channel/general) for help from the community. # 👥 Contributions Rocket.Chat is an open-source project, and we are very happy to accept community contributions. Refer to the [Contribution guide](https://developer.rocket.chat/docs/contribute-to-rocketchat) for more details. # 💼 Become a Rocketeer We're hiring developers, technical support, and product managers all the time. Check out our [jobs page](https://rocket.chat/jobs). # 🗞️ Get the Latest News - [Blog](https://rocket.chat/blog) - [Twitter](https://twitter.com/RocketChat) - [Facebook](https://www.facebook.com/RocketChatApp) - [LinkedIn](https://www.linkedin.com/company/rocket-chat) - [Youtube](https://www.youtube.com/channel/UCin9nv7mUjoqrRiwrzS5UVQ) # 🗒️ Credits - Emoji provided graciously by [JoyPixels](https://www.joypixels.com). ================================================================================ ================================================================================ FILE: packages/fuselage-ui-kit/README.md Relevance Score: 0.970 | Chunks Retrieved: 1 | Tokens: 886 ================================================================================

# `@rocket.chat/fuselage-ui-kit` > UiKit elements for Rocket.Chat Apps built under Fuselage design system --- [![npm@latest](https://img.shields.io/npm/v/@rocket.chat/fuselage-ui-kit/latest?style=flat-square)](https://www.npmjs.com/package/@rocket.chat/icons/v/latest) [![npm@next](https://img.shields.io/npm/v/@rocket.chat/fuselage-ui-kit/next?style=flat-square)](https://www.npmjs.com/package/@rocket.chat/icons/v/next) ![react version](https://img.shields.io/npm/dependency-version/@rocket.chat/fuselage-ui-kit/peer/react?style=flat-square) [![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)](https://rocketchat.github.io/Rocket.Chat.Fuselage/fuselage-ui-kit) ![npm downloads](https://img.shields.io/npm/dw/@rocket.chat/fuselage-ui-kit?style=flat-square) ![License: MIT](https://img.shields.io/npm/l/@rocket.chat/fuselage-ui-kit?style=flat-square) ![deps](https://img.shields.io/david/RocketChat/fuselage?path=packages%2Ffuselage-ui-kit&style=flat-square) ![peer deps](https://img.shields.io/david/peer/RocketChat/fuselage?path=packages%2Ffuselage-ui-kit&style=flat-square) ![dev deps](https://img.shields.io/david/dev/RocketChat/fuselage?path=packages%2Ffuselage-ui-kit&style=flat-square) ![npm bundle size](https://img.shields.io/bundlephobia/min/@rocket.chat/fuselage-ui-kit?style=flat-square) ## Install Firstly, install the peer dependencies (prerequisites): ```sh npm i @rocket.chat/fuselage @rocket.chat/fuselage-hooks @rocket.chat/icons @rocket.chat/styled react react-dom # or, if you are using yarn: yarn add @rocket.chat/fuselage @rocket.chat/fuselage-hooks @rocket.chat/icons @rocket.chat/styled react react-dom ``` Add `@rocket.chat/fuselage-ui-kit` as a dependency: ```sh npm i @rocket.chat/fuselage-ui-kit # or, if you are using yarn: yarn add @rocket.chat/fuselage-ui-kit ``` ## Contributing Contributions, issues, and feature requests are welcome!
Feel free to check the [issues](https://github.com/RocketChat/fuselage/issues). ### Building As this package dependends on others in this monorepo, before anything run the following at the root directory: ```sh yarn build ``` ### Linting To ensure the source is matching our coding style, we perform [linting](). Before commiting, check if your code fits our style by running: ```sh yarn lint ``` Some linter warnings and errors can be automatically fixed: ```sh yarn lint-and-fix ``` ### Component stories We develop and describe our visual components in the form of stories, manage by a tool called [Storybook](https://storybook.js.org/). To start developing with Storybook, run: ```sh yarn storybook ``` ================================================================================ ================================================================================ FILE: packages/ui-kit/README.md Relevance Score: 0.960 | Chunks Retrieved: 1 | Tokens: 587 ================================================================================

# `@rocket.chat/ui-kit` > Interactive UI elements for Rocket.Chat Apps --- [![npm@latest](https://img.shields.io/npm/v/@rocket.chat/ui-kit/latest?style=flat-square)](https://www.npmjs.com/package/@rocket.chat/ui-kit/v/latest) [![npm@next](https://img.shields.io/npm/v/@rocket.chat/ui-kit/next?style=flat-square)](https://www.npmjs.com/package/@rocket.chat/ui-kit/v/next) ![npm downloads](https://img.shields.io/npm/dw/@rocket.chat/ui-kit?style=flat-square) ![License: MIT](https://img.shields.io/npm/l/@rocket.chat/ui-kit?style=flat-square) ![deps](https://img.shields.io/librariesio/release/npm/@rocket.chat/ui-kit?style=flat-square) ![npm bundle size](https://img.shields.io/bundlephobia/min/@rocket.chat/ui-kit?style=flat-square) ## Install Add `@rocket.chat/ui-kit` as a dependency: ```sh npm i @rocket.chat/ui-kit # or, if you are using yarn: yarn add @rocket.chat/ui-kit ``` ## Contributing Contributions, issues, and feature requests are welcome!
Feel free to check the [issues](https://github.com/RocketChat/Rocket.Chat/issues). ### Building As this package dependends on others in this monorepo, before anything run the following at the root directory: ```sh yarn build ``` ### Linting To ensure the source is matching our coding style, we perform [linting](). Before commiting, check if your code fits our style by running: ```sh yarn lint ``` Some linter warnings and errors can be automatically fixed: ```sh yarn lint-and-fix ``` ### Running tests Whenever possible, add tests to describe exactly what your code do. You can run them by yourself: ```sh yarn test ``` ================================================================================ ================================================================================ FILE: packages/apps-engine/package.json Relevance Score: 0.950 | Chunks Retrieved: 1 | Tokens: 1,297 ================================================================================ { "name": "@rocket.chat/apps-engine", "version": "1.58.0", "description": "The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.", "keywords": [ "rocket.chat", "team chat", "apps engine" ], "homepage": "https://github.com/RocketChat/Rocket.Chat.Apps-engine#readme", "bugs": { "url": "https://github.com/RocketChat/Rocket.Chat.Apps-engine/issues%22 }, "repository": { "type": "git", "url": "git+https://github.com/RocketChat/Rocket.Chat.Apps-engine.git%22 }, "license": "MIT", "author": { "name": "Rocket.Chat", "url": "https://rocket.chat/" }, "contributors": [ { "name": "Bradley Hilton", "email": "bradley.hilton@rocket.chat" }, { "name": "Rodrigo Nascimento", "email": "rodrigo.nascimento@rocket.chat" }, { "name": "Douglas Gubert", "email": "douglas.gubert@rocket.chat" } ], "files": [ "client/**", "definition/**", "deno-runtime/**", "lib/**", "scripts/**", "server/**" ], "scripts": { ".:build:clean": "rimraf client definition server", ".:build:default": "tsc -p tsconfig.json", ".:build:deno-cache": "node scripts/deno-cache.js", ".:deno-fmt:fix": "cd deno-runtime && deno fmt", ".:eslint:fix": "eslint . --fix", ".:lint:deno": "deno lint --ignore=deno-runtime/.deno deno-runtime/", ".:lint:eslint": "eslint .", ".:test:deno": "cd deno-runtime && deno task test", ".:test:node": "NODE_ENV=test ts-node --transpileOnly ./tests/runner.ts", "build": "run-s .:build:clean .:build:default .:build:deno-cache", "bundle": "node scripts/bundle.js", "dev": "yarn .:build:default --watch", "fix-lint": "yarn .:eslint:fix && yarn .:deno-fmt:fix", "gen-doc": "typedoc", "lint": "yarn .:lint:eslint && yarn .:lint:deno", "prepack": "yarn bundle", "start": "run-s .:build:clean .:build:watch", "testunit": "run-p .:test:node .:test:deno", "typecheck": "tsc -p tsconfig.json --noEmit" }, "nyc": { "all": true, "extension": [ ".ts" ], "include": [ "src/*.ts", "src/server/**/*.ts" ], "reporter": [ "lcov", "json", "html" ] }, "dependencies": { "@msgpack/msgpack": "3.0.0-beta2", "adm-zip": "^0.5.16", "debug": "^4.3.7", "esbuild": "~0.25.12", "jose": "^4.15.9", "jsonrpc-lite": "^2.2.0", "lodash.clonedeep": "^4.5.0", "semver": "^7.6.3", "stack-trace": "0.0.10", "uuid": "~11.0.5" }, "devDependencies": { "@rocket.chat/eslint-config": "workspace:~", "@rocket.chat/ui-kit": "workspace:~", "@seald-io/nedb": "^4.1.2", "@types/adm-zip": "^0.5.7", "@types/debug": "^4.1.12", "@types/lodash.clonedeep": "^4.5.9", "@types/node": "~22.16.5", "@types/semver": "^7.5.8", "@types/stack-trace": "0.0.33", "@types/uuid": "~10.0.0", "@typescript-eslint/eslint-plugin": "~5.60.1", "@typescript-eslint/parser": "~5.60.1", "alsatian": "^2.4.0", "browserify": "^16.5.2", "eslint": "~8.45.0", "npm-run-all": "^4.1.5", "nyc": "^17.1.0", "rimraf": "^6.0.1", "tap-bark": "^1.0.0", "ts-node": "^6.2.0", "typedoc": "~0.28.14", "typescript": "~5.9.3", "uglify-es": "^3.3.10" }, "volta": { "extends": "../../package.json" }, "publishConfig": { "access": "public" }, "installConfig": { "hoistingLimits": "workspaces" } } ================================================================================ ================================================================================ FILE: package.json Relevance Score: 0.940 | Chunks Retrieved: 1 | Tokens: 1,037 ================================================================================ { "name": "rocket.chat", "version": "8.0.0-develop", "private": true, "description": "Rocket.Chat Monorepo", "homepage": "https://github.com/RocketChat/Rocket.Chat#readme", "bugs": { "url": "https://github.com/RocketChat/Rocket.Chat/issues%22 }, "repository": { "type": "git", "url": "git+https://github.com/RocketChat/Rocket.Chat.git%22 }, "license": "MIT", "author": "", "main": "index.js", "workspaces": [ "apps/*", "packages/*", "ee/apps/*", "ee/packages/*", "apps/meteor/ee/server/services" ], "scripts": { "build": "turbo run build", "build:services": "turbo run build --filter=rocketchat-services...", "dev": "turbo run dev --env-mode=loose --parallel --filter=@rocket.chat/meteor...", "dsv": "turbo run dsv --env-mode=loose --filter=@rocket.chat/meteor...", "fossify": "TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\"}' ts-node scripts/fossify.ts", "fuselage": "./fuselage.sh", "lint": "turbo run lint", "storybook": "yarn workspace @rocket.chat/meteor run storybook", "test-storybook": "turbo run test-storybook", "testunit": "turbo run testunit" }, "resolutions": { "@react-pdf/fns": "2.0.1", "@react-pdf/font": "2.3.7", "@react-pdf/image": "2.2.2", "@react-pdf/layout": "3.6.3", "@react-pdf/pdfkit": "3.0.2", "@react-pdf/png-js": "2.2.0", "@react-pdf/primitives": "3.0.1", "@react-pdf/render": "3.2.7", "@react-pdf/renderer": "3.1.14", "@react-pdf/stylesheet": "4.1.8", "@react-pdf/textkit": "4.2.0", "@react-pdf/types": "2.3.4", "@react-pdf/yoga": "4.1.2", "@sematext/gc-stats@npm:^1.5.9": "patch:@sematext/gc-stats@npm%3A1.5.9#~/.yarn/patches/@sematext-gc-stats-npm-1.5.9-01e77be4d0.patch", "adm-zip": "0.5.9", "cross-spawn": "7.0.6", "drachtio-srf": "patch:drachtio-srf@npm%3A5.0.12#~/.yarn/patches/drachtio-srf-npm-5.0.12-b0b1afaad6.patch", "lodash": "4.17.21", "minimist": "1.2.6", "mongodb": "6.10.0", "underscore": "1.13.7" }, "dependencies": { "@types/stream-buffers":