-
Notifications
You must be signed in to change notification settings - Fork 10.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ef19740
commit 88b8a95
Showing
1 changed file
with
75 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,103 +1,135 @@ | ||
| <img src="https://github.com/RocketChat/Rocket.Chat.Artwork/raw/master/Logos/2020/png/logo-horizontal-red.png" data-canonical-src="https://github.com/RocketChat/Rocket.Chat.Artwork/raw/master/Logos/2020/png/logo-horizontal-red.png" width="500" /> | ||
| <p align="center"> | ||
| <img src="https://github.com/RocketChat/Rocket.Chat.Artwork/raw/master/Logos/2020/png/logo-horizontal-red.png" data-canonical-src="https://github.com/RocketChat/Rocket.Chat.Artwork/raw/master/Logos/2020/png/logo-horizontal-red.png" width="400" /> | ||
| </p> | ||
|
|
||
| <h1 align="center"> | ||
| The ultimate Free Open Source Solution for team communications. | ||
| The ultimate Free Open Source Solution for team communications | ||
| </h1> | ||
|
|
||
| <p align="center"> | ||
| <img src="https://img.shields.io/github/v/release/RocketChat/Rocket.Chat?label=version"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/RocketChat/Rocket.Chat/build_and_test.yml"> | ||
| <img src="https://img.shields.io/badge/license-MIT-green"> | ||
| <img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/RocketChat/Rocket.Chat/develop"> | ||
| </p> | ||
|
|
||
|
|
||
|
|
||
| [Rocket.Chat](https://rocket.chat) is an open-source fully customizable communications platform developed in JavaScript for organizations with high standards of data protection. | ||
|
|
||
| We are a MERN based application 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. | ||
| 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. | ||
|
|
||
| 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](https://rocket.chat) to keep their communications completely private and secure. | ||
| 🎯 **Omnichannel customer service** - Engage in seamless interactions with customers regardless of how they connect with you. | ||
|
|
||
| - [Review product documentation](https://docs.rocket.chat) | ||
| - [Review developer documentation](https://developer.rocket.chat) | ||
| 🦾 **Chat engine** - Create customized messaging experiences within your mobile or web app. | ||
|
|
||
| Using our self-managed offerings you can deploy Rocket.Chat on your own server, or you can use SaaS Rocket.Chat. We offer support for both community as well as commercial plans. | ||
| 🤖 **Marketplace** - Choose a wide range of apps and native integrations that help your business communicate more effectively. | ||
|
|
||
| <img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat.Artwork/master/Product%20Images/Welcome%20to%20RC%20(Readme).jpg" data-canonical-src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat.Artwork/master/Product%20Images/Welcome%20to%20RC%20(Readme).jpg" width="919" height="511" /> | ||
| <img src="https://global-uploads.webflow.com/611a19b9853b7414a0f6b3f6/6319c72bbd8af5c8c22efab6_heroImage.webp" data-canonical-src="https://global-uploads.webflow.com/611a19b9853b7414a0f6b3f6/6319c72bbd8af5c8c22efab6_heroImage.webp" /> | ||
|
|
||
| ## Cloud Hosted Rocket.Chat | ||
| # ☁️ Cloud Hosted Rocket.Chat | ||
|
|
||
| https://cloud.rocket.chat/trial | ||
| Send your first message in minutes. | ||
|
|
||
| ## Local development | ||
| 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. | ||
|
|
||
| ### Prerequisites | ||
| [Start your cloud hosted trial now](https://rocket.chat/trial-saas) | ||
|
|
||
| # 🛠️ Local development | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You can follow these instructions to setup a dev environment: | ||
|
|
||
| - Install **Node 14.x (LTS)** either [manually](https://nodejs.org/dist/latest-v14.x/) or using a tool like [nvm](https://github.com/creationix/nvm) (recommended) | ||
| - Install **Meteor**: https://www.meteor.com/developers/install | ||
| - Install **Node 14.x (LTS)** either [manually](https://nodejs.org/dist/latest-v14.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://www.meteor.com/developers/install | ||
| - Install **yarn**: https://yarnpkg.com/getting-started/install | ||
| - Clone this repo: `git clone https://github.com/RocketChat/Rocket.Chat.git` | ||
| - Run `yarn` to install dependencies | ||
|
|
||
| ### Starting Rocket.Chat | ||
| **Starting Rocket.Chat:** | ||
|
|
||
| ```bash | ||
| yarn dev # run all packages | ||
| ``` | ||
| yarn dsv | ||
| 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 | ||
|
|
||
| ### Starting Rocket.Chat in microservices mode | ||
| **Starting Rocket.Chat in microservices mode:** | ||
|
|
||
| ``` | ||
| ```bash | ||
| yarn turbo run ms | ||
| ``` | ||
|
|
||
| After initialized, you can access the server at http://localhost:4000 | ||
|
|
||
| ## Installation | ||
| > ⚠️ Check more detailed informations in the [Rocket.Chat Environment Setup](https://developer.rocket.chat/rocket.chat/rocket-chat-environment-setup) guide | ||
| # 💻 Installation | ||
|
|
||
| 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. | ||
|
|
||
| ## Feature Request | ||
| # 📱 Mobile Apps | ||
|
|
||
| [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). | ||
| In addition to the web interface, you can also download Rocket.Chat clients for: | ||
|
|
||
| ## Community | ||
|
|
||
| Join thousands of members worldwide in our [community server](https://open.rocket.chat). | ||
| Join [#Support](https://open.rocket.chat/channel/support) for help from our community with general Rocket.Chat questions. | ||
| Join [#Dev](https://open.rocket.chat/channel/dev) for needing help from the community to develop new features. | ||
| Talk with Rocket.Chat's leadership at the [Community Open Call](https://www.youtube.com/playlist?list=PLee3gqXJQrFVaxryc0OKTKc92yqQX9U-5), held monthly. Join us for [the next Community Open Call](https://app.livestorm.co/rocket-chat/community-open-call?type=detailed). | ||
| [](https://itunes.apple.com/us/app/rocket-chat/id1148741252?mt=8) [](https://play.google.com/store/apps/details?id=chat.rocket.android) [](https://f-droid.org/en/packages/chat.rocket.android) | ||
|
|
||
| ## Contributions | ||
| 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) | ||
|
|
||
| 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) for more details. | ||
| # 🧩 Apps Engine for Rocket.Chat | ||
|
|
||
| ## Credits | ||
| 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 | ||
|
|
||
| - Emoji provided graciously by [JoyPixels](https://www.joypixels.com). | ||
| - Testing with [BrowserStack](https://www.browserstack.com). | ||
| - Translations done with [LingoHub](https://lingohub.com). | ||
| # 📚 Learn More | ||
|
|
||
| ## Mobile Apps | ||
| - [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) | ||
| - [See who's using Rocket.Chat](https://www.rocket.chat/customers) | ||
|
|
||
| In addition to the web interface, you can also download Rocket.Chat clients for: | ||
| # 🆕 Feature Request | ||
|
|
||
| [](https://itunes.apple.com/us/app/rocket-chat/id1148741252?mt=8) [](https://play.google.com/store/apps/details?id=chat.rocket.android) [](https://f-droid.org/en/packages/chat.rocket.android) | ||
| [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 | ||
|
|
||
| ## Learn More | ||
| 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. | ||
|
|
||
| - [API](https://developer.rocket.chat/reference/api) | ||
| - [See who's using Rocket.Chat](https://rocket.chat/customer-stories) | ||
|
|
||
| ## Become a Rocketeer | ||
| # 👥 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. | ||
|
|
||
|
|
||
| ## 💼 Become a Rocketeer | ||
|
|
||
| We're hiring developers, support people, and product managers all the time. Please check our [jobs page](https://rocket.chat/jobs). | ||
|
|
||
| ## Get the Latest News | ||
| ## 🗞️ Get the Latest News | ||
|
|
||
| - [Twitter](https://twitter.com/RocketChat) | ||
| - [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) | ||
| - [Email Newsletter](https://rocket.chat/newsletter) | ||
|
|
||
| Any other questions, reach out to us at [our website](https://rocket.chat/contact) or you can email us directly at [contact@rocket.chat](mailto:contact@rocket.chat). We’d be happy to help! | ||
| ## 🗒️ Credits | ||
|
|
||
| - Emoji provided graciously by [JoyPixels](https://www.joypixels.com). |