diff --git a/README.md b/README.md index 24ce42485bdeb..fb0e88ddd4eb4 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ We are the ultimate **Free Open Source Solution** for team communications, enabl 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 +# 🚀 Product Offerings - Self-hosted and Cloud Rocket.Chat has four key product offerings: @@ -35,88 +35,55 @@ Rocket.Chat has four key product offerings: -# ☁️ Cloud Hosted Rocket.Chat +# ☁️ Cloud-hosted Rocket.Chat -Send your first message in minutes. +Send your first message in minutes! Enjoy your free trial [cloud-hosted workspace](https://docs.rocket.chat/docs/saas-trial) for 30 days. Explore the benefits and decide whether to continue using our secure cloud hosting or migrate to your private cloud, data center, or air-gapped environment. -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](https://rocket.chat/trial-saas) +[Start your cloud-hosted trial now!](https://rocket.chat/trial-saas) # 📖 Docs for Developers, Admins and Users -Please make sure to visit our [Docs](https://docs.rocket.chat/) and [Developer Docs](https://developer.rocket.chat/docs) before sending questions. - -# 🛠️ Local development - -## Prerequisites - -You can follow these instructions to setup a dev environment: - -- Install **Node 22.x (LTS)** either [manually](https://nodejs.org/dist/latest-v22.x/) or using a tool like [nvm](https://github.com/creationix/nvm) or [volta](https://volta.sh/) (recommended) -- Install **Meteor** ([version here](apps/meteor/.meteor/release)): 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:** - -```bash -yarn dev # run all packages -``` -OR -```bash -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](https://developer.rocket.chat/v1/docs/server-environment-setup) -PS: For Windows you MUST use WSL2 and have +12Gb RAM +Visit our official [User Documentation](https://docs.rocket.chat/) and [Developer Docs](https://developer.rocket.chat/docs) before sending questions. +# 🛠️ Local Development -# Gitpod Setup +You can set up a Rocket.Chat server development environment by following the guide below for your operating system: -1. Click the button below to open this project in Gitpod. -2. This will open a fully configured workspace in your browser with all the necessary dependencies already installed. +- [Linux](https://developer.rocket.chat/docs/linux): See how to set up a Rocket.Chat server development environment on any Linux distribution. -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/RocketChat/Rocket.Chat) +- [Mac OSX](https://developer.rocket.chat/docs/mac-osx): Learn how to set up a Rocket.Chat server development environment on Mac. -**Starting Rocket.Chat in microservices mode:** +- [Windows 10](https://developer.rocket.chat/docs/windows-10): Set up a Rocket.Chat server development environment on Windows. -```bash -yarn turbo run ms -``` +- [Gitpod](https://developer.rocket.chat/docs/gitpod): Use the online development environment pre-configuration to develop Rocket.Chat server. -After initialized, you can access the server at http://localhost:4000 +> Visit the [Rocket.Chat Environment Setup guide](https://developer.rocket.chat/docs/server-environment-setup) to learn more. -> ⚠️ Check more detailed information in the [Rocket.Chat Environment Setup](https://developer.rocket.chat/docs/server-environment-setup) guide -# 💻 Installation +# 💻 Deploy Rocket.Chat -Please see the [requirements documentation](https://docs.rocket.chat/deploy/installing-client-apps/minimum-requirements-for-using-rocket.chat) for system requirements and more information about supported operating systems. -Please refer to [Install Rocket.Chat](https://rocket.chat/install) to install your Rocket.Chat instance. +Refer to the [System requirements documentation](https://docs.rocket.chat/docs/system-requirements) for required hardware and software specifications. For detailed instructions on deploying your Rocket.Chat workspace, visit [Deploy Rocket.Chat](https://rocket.chat/install). -# 📱 Mobile Apps +# 📱 Mobile apps -In addition to the web interface, you can also download Rocket.Chat clients for: +In addition to the web app, you can also download Rocket.Chat clients for: [![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) [![](https://user-images.githubusercontent.com/551004/48210349-50649480-e35e-11e8-97d9-74a4331faf3a.png)](https://f-droid.org/en/packages/chat.rocket.android) -You can also contribute to the Mobile open source code in [Rocket.Chat.ReactNative](https://github.com/RocketChat/Rocket.Chat.ReactNative) and check it out its [documentation](https://developer.rocket.chat/mobile-app/mobile-app-environment-setup) +You can also contribute to the mobile open source code in [Rocket.Chat.ReactNative](https://github.com/RocketChat/Rocket.Chat.ReactNative) and check it out its [documentation](https://developer.rocket.chat/docs/mobile-app). # 🧩 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](https://developer.rocket.chat/apps-engine/getting-started) increasing the world of possibilities of integrations around the Rocket.Chat ecosystem +You can develop your own app that can be integrated with Rocket.Chat. We provide an [Open Source Apps-Engine framework](https://developer.rocket.chat/apps-engine/getting-started) which expands the integration possibilities within the Rocket.Chat ecosystem. # 📚 Learn More -- [Product Documentation](https://docs.rocket.chat) -- [Developer Documentation](https://developer.rocket.chat) -- [API Documentation](https://developer.rocket.chat/reference/api) -- [Apps Engine Development](https://developer.rocket.chat/apps-engine/rocket.chat-apps-and-apps-engine) +- [User documentation](https://docs.rocket.chat) +- [Developer documentation](https://developer.rocket.chat) +- [API documentation](https://developer.rocket.chat/reference/api) +- [Apps-Engine development](https://developer.rocket.chat/apps-engine/rocket.chat-apps-and-apps-engine) - [See who's using Rocket.Chat](https://www.rocket.chat/customers) # 🆕 Feature Request @@ -131,14 +98,14 @@ Join [#support](https://open.rocket.chat/channel/support) and [#general](https:/ # 👥 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?](https://developer.rocket.chat/contribute-to-rocket.chat/ways-to-contribute) page for more details. +Rocket.Chat is an open source project and we are very happy to accept community contributions. Refer to the [Modes of contribution guide](https://developer.rocket.chat/contribute-to-rocket.chat/ways-to-contribute) for more details. -## 💼 Become a Rocketeer +# 💼 Become a Rocketeer -We're hiring developers, support people, and product managers all the time. Please check our [jobs page](https://rocket.chat/jobs). +We're hiring developers, support people, and product managers all the time. Check out our [jobs page](https://rocket.chat/jobs). -## 🗞️ Get the Latest News +# 🗞️ Get the Latest News - [Blog](https://rocket.chat/blog) - [Twitter](https://twitter.com/RocketChat) @@ -146,6 +113,6 @@ We're hiring developers, support people, and product managers all the time. Plea - [LinkedIn](https://www.linkedin.com/company/rocket-chat) - [Youtube](https://www.youtube.com/channel/UCin9nv7mUjoqrRiwrzS5UVQ) -## 🗒️ Credits +# 🗒️ Credits - Emoji provided graciously by [JoyPixels](https://www.joypixels.com).