mirror of https://github.com/RocketChat/Rocket.Chat.git synced 2025-12-28 06:47:25 +00:00

The communications platform that puts data protection first.

chat collaboration foss free hacktoberfest javascript meteor mit real-time slack webrtc

Go to file

Marcos Spessatto Defendi 1bf0c451dc Some checks are pending Deploy GitHub Pages / deploy-preview (push) Waiting to run Details CI / ⚙️ Variables Setup (push) Waiting to run Details CI / 🚀 Notify external services - draft (push) Blocked by required conditions Details CI / 📦 Build Packages (push) Blocked by required conditions Details CI / deploy-preview (push) Blocked by required conditions Details CI / 📦 Meteor Build - coverage (push) Blocked by required conditions Details CI / 📦 Meteor Build - official (push) Blocked by required conditions Details CI / Builds matrix rust bindings against alpine (push) Waiting to run Details CI / 🚢 Build Docker Images for Testing (alpine) (push) Blocked by required conditions Details CI / 🚢 Build Docker Images for Production (alpine) (push) Blocked by required conditions Details CI / 🔎 Code Check (push) Blocked by required conditions Details CI / 🔨 Test Unit (push) Blocked by required conditions Details CI / 🔨 Test API (CE) (push) Blocked by required conditions Details CI / 🔨 Test UI (CE) (push) Blocked by required conditions Details CI / 🔨 Test API (EE) (push) Blocked by required conditions Details CI / 🔨 Test UI (EE) (push) Blocked by required conditions Details CI / ✅ Tests Done (push) Blocked by required conditions Details CI / 🚀 Publish build assets (push) Blocked by required conditions Details CI / 🚀 Publish Docker Image (main) (alpine) (push) Blocked by required conditions Details CI / 🚀 Publish Docker Image (services) (account) (push) Blocked by required conditions Details CI / 🚀 Publish Docker Image (services) (authorization) (push) Blocked by required conditions Details CI / 🚀 Publish Docker Image (services) (ddp-streamer) (push) Blocked by required conditions Details CI / 🚀 Publish Docker Image (services) (omnichannel-transcript) (push) Blocked by required conditions Details CI / 🚀 Publish Docker Image (services) (presence) (push) Blocked by required conditions Details CI / 🚀 Publish Docker Image (services) (queue-worker) (push) Blocked by required conditions Details CI / 🚀 Publish Docker Image (services) (stream-hub) (push) Blocked by required conditions Details CI / 🚀 Notify external services (push) Blocked by required conditions Details CI / Update Version Durability (push) Blocked by required conditions Details Code scanning - action / CodeQL-Build (push) Waiting to run Details refactor: remove messageSearch method calls (server) (#34979 )		2025-01-30 13:06:37 +00:00
_templates	chore: Move models to package (#34154 )	2024-12-26 19:51:57 -05:00
.changeset	fix: encode error messages (#35038 )	2025-01-30 01:06:22 +00:00
.devcontainer	chore: adds Gitpod Flex support (#34916 )	2025-01-21 01:15:12 +00:00
.github	ci: remove broken trigger dependent workflows job (#35040 )	2025-01-27 11:17:32 -03:00
.gitpod	chore: adds Gitpod Flex support (#34916 )	2025-01-21 01:15:12 +00:00
.houston
.vscode	refactor: JSX automatic runtime (#34498 )	2024-12-26 16:12:18 -05:00
.yarn	chore: Upgrade React (#32288 )	2025-01-28 22:22:33 -05:00
apps	refactor: remove messageSearch method calls (server) (#34979 )	2025-01-30 13:06:37 +00:00
development	feat: Trace api calls (#32779 )	2024-10-18 21:03:47 -04:00
ee	chore: Upgrade React (#32288 )	2025-01-28 22:22:33 -05:00
packages	refactor: Replace `useUniqueId` with `useId` (#35061 )	2025-01-30 03:14:01 -03:00
scripts	chore: replace fs+promisify with fs/promises (#33599 )	2024-10-15 22:51:53 -04:00
.editorconfig
.gitignore	feat: Trace api calls (#32779 )	2024-10-18 21:03:47 -04:00
.hygen.js
.kodiak.toml	ci: remove dependabot from update ignore	2024-11-12 18:41:43 -03:00
.npmrc
.prettierrc
.tool-versions	chore: Move Apps-Engine to monorepo (#32951 )	2024-09-27 18:36:57 -04:00
.yarnrc.yml	chore(deps): Upgrade Yarn (#34953 )	2025-01-16 14:30:50 -03:00
app.json
CODE_OF_CONDUCT.md
codecov.yml	ci: add back carryforward flag (#31605 )	2024-02-01 17:47:19 -03:00
docker-compose-ci.yml	chore: Move Apps-Engine to monorepo (#32951 )	2024-09-27 18:36:57 -04:00
docker-compose-local.yml	chore!: Removed Mongo 4.4. support and added 7.0 (#32162 )	2024-10-17 01:28:15 -03:00
FEATURES.md	chore!: remove hipchat importer (#32154 )	2024-10-17 01:28:15 -03:00
fuselage.sh	chore: Remove `ui-kit` from `yarn fuselage` script (#32942 )	2024-07-31 20:13:23 -04:00
HISTORY.md	Merge branch 'master' into release-6.3.0	2023-08-02 16:13:22 -03:00
LICENSE
LIMITATION_OF_RESPONSIBILITY.md
package.json	chore(deps): bump dependencies with known issues (#35007 )	2025-01-24 17:00:28 +00:00
postcss.config.js
README.md	docs: Update environment setup doc link in README.md (#33603 )	2024-10-29 10:55:44 -04:00
Rocket.Chat.sublime-project	chore: rename sublime project file (#31206 )	2023-12-11 14:29:27 -03:00
SECURITY.md
tsconfig.base.client.json	chore: Upgrade React (#32288 )	2025-01-28 22:22:33 -05:00
tsconfig.base.json
tsconfig.base.server.json	feat: Trace api calls (#32779 )	2024-10-18 21:03:47 -04:00
turbo.json	chore: bump meteor and node version (#34048 )	2025-01-03 15:08:09 -05:00
VIP Sponsors.md
yarn.lock	refactor: Abandon `useSyncExternalStore` shim (#35051 )	2025-01-29 10:02:27 -05:00

README.md

The ultimate Free Open Source Solution for team communications

Codecov branch

Rocket.Chat is an open-source fully customizable communications platform developed in JavaScript for organizations with high standards of data protection.

We are the ultimate Free Open Source Solution for team communications, enabling real-time conversations between colleagues, with other companies or with your customers, regardless of how they connect with you. The result is an increase in productivity and customer 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.

🚀 Product Offerings - Self Hosted and Cloud

Rocket.Chat has four key product offerings:

💬 Team collaboration - A single point for secure internal and cross-company collaboration.

🎯 Omnichannel customer service - Engage in seamless interactions with customers regardless of how they connect with you.

🦾 Chat engine - Create customized messaging experiences within your mobile or web app.

🤖 Marketplace - Choose a wide range of apps and native integrations that help your business communicate more effectively.

☁️ Cloud Hosted Rocket.Chat

Send your first message in minutes.

Free for 30 days. Afterward, choose between continuing to host on our secure cloud or migrating to your private cloud, data center, or even air-gapped environment.

Start your cloud hosted trial now

🛠️ Local development

Prerequisites

You can follow these instructions to setup a dev environment:

Install Node 20.x (LTS) either manually or using a tool like nvm or volta (recommended)
Install Meteor (version here): https://docs.meteor.com/about/install.html
Install yarn: https://yarnpkg.com/getting-started/install
Install Deno 1.x: https://docs.deno.com/runtime/fundamentals/installation/
Clone this repo: git clone https://github.com/RocketChat/Rocket.Chat.git
Run yarn to install dependencies

Starting Rocket.Chat:

yarn dev # run all packages

yarn dsv # run only meteor (front and back) with pre-built packages

After initialized, you can access the server at http://localhost:3000

More details at: Developer Docs PS: For Windows you MUST use WSL2 and have +12Gb RAM

Gitpod Setup

Click the button below to open this project in Gitpod.
This will open a fully configured workspace in your browser with all the necessary dependencies already installed.

Starting Rocket.Chat in microservices mode:

yarn turbo run ms

After initialized, you can access the server at http://localhost:4000

⚠️ Check more detailed information in the Rocket.Chat Environment Setup guide

💻 Installation

Please see the requirements documentation for system requirements and more information about supported operating systems. Please refer to Install Rocket.Chat to install your Rocket.Chat instance.

📱 Mobile Apps

In addition to the web interface, you can also download Rocket.Chat clients for:

You can also contribute to the Mobile open source code in Rocket.Chat.ReactNative and check it out its documentation

🧩 Apps Engine for Rocket.Chat

You can develop your own app that can be integrated with Rocket.Chat. We provide an Open Source Apps Engine framework increasing the world of possibilities of integrations around the Rocket.Chat ecosystem

📚 Learn More

🆕 Feature Request

Rocket.Chat/feature-requests is used to track Rocket.Chat feature requests and discussions. Click here to open a new feature request. Feature Request Forums stores the historical archives of old feature requests (up to 2018).

🤝 Community

Join thousands of members worldwide in our community server. Join #support and #general for help from the community.

👥 Contributions

Rocket.Chat is an open source project and we are very happy to accept community contributions. Please refer to the How can I help? page for more details.

💼 Become a Rocketeer

We're hiring developers, support people, and product managers all the time. Please check our jobs page.

🗞️ Get the Latest News

🗒️ Credits

Emoji provided graciously by JoyPixels.