Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rocketchat/embeddedchat
An easy to use full-stack component (ReactJS) embedding Rocket.Chat into your webapp
https://github.com/rocketchat/embeddedchat
embeddedchat javascript npm react rocketchat rocketchat-sdk
Last synced: 1 day ago
JSON representation
An easy to use full-stack component (ReactJS) embedding Rocket.Chat into your webapp
- Host: GitHub
- URL: https://github.com/rocketchat/embeddedchat
- Owner: RocketChat
- Created: 2022-06-02T15:21:08.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-11T16:32:34.000Z (4 months ago)
- Last Synced: 2024-10-11T19:10:30.270Z (4 months ago)
- Topics: embeddedchat, javascript, npm, react, rocketchat, rocketchat-sdk
- Language: JavaScript
- Homepage: https://rocketchat.github.io/EmbeddedChat/docs
- Size: 15.9 MB
- Stars: 115
- Watchers: 10
- Forks: 231
- Open Issues: 108
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Embedded Chat: A staple in excellent customer service
An easy-to-use, full-stack component (React.js + backend behaviors) for embedding Rocket.Chat into your web app.
_EmbeddedChat is a full-stack React component designed to integrate Rocket.Chat into your web app. It is fully configurable, extensible, and flexible, offering various preconfigured designs, multiple login options, and more. The component is tightly integrated with the Rocket.Chat server using the Rocket.Chat SDK, and its entire UI is built using custom components._
## Try It Out 🚀
Explore our project in action! It's live for a sneak peek and testing at: https://rocketchat.github.io/EmbeddedChat/
Test credentials:
- **Username:** test_acc
- **Password:** test_acc
## Installation and Usage
Installation and usage documentation could be found here [EmbeddedChat installation and usage](https://rocketchat.github.io/EmbeddedChat/docs/docs/Usage/embeddedchat_setup)
## Development
### Local Setup
To develop and test `EmbeddedChat`, you need a local instance of the Rocket.Chat server. Follow the guide in the [Rocket.Chat Developer Docs](https://developer.rocket.chat/v1/docs/server-environment-setup) for setting up a Rocket.Chat development environment.
Ensure that the "Enable CORS" option is turned on in your Rocket.Chat server. You can find it under Administration > Settings > General > REST API > Enable CORS. This setting must be enabled to access the app's functionality.
#### Prerequisites
- **Node.js**: Version 16.19.0 is required. Use [Node Version Manager (NVM)](https://github.com/nvm-sh/nvm) for easy switching between Node.js versions.
To install and use the correct Node.js version, execute the following commands with the specific version number:
```bash
nvm install
nvm use
```
Replace `` with the required Node.js version
- **Yarn Workspaces**: Ensure Yarn workspaces are enabled. If not, run:
```bash
corepack enable
```
#### Install Dependencies
Install all necessary dependencies by navigating to the root directory of `EmbeddedChat` and running:
```bash
yarn
```
#### Build Packages
After installing dependencies, build the packages (`auth`, `api`, and `react`) by running the following command in the root directory:
```bash
yarn build
```
#### Starting Storybook for React
Navigate to the `react` package directory and start Storybook with the following commands:
```bash
cd packages/react
yarn storybook
```
Storybook should now be operational. Experiment with `EmbeddedChat` and its components, observing real-time changes in Storybook.
### Custom Rocket Chat Server Configuration
By default, Storybook connects to `http://localhost:3000`. To use a different Rocket Chat server:
Create a `.env` file in the `packages/react` directory.
Set the `STORYBOOK_RC_HOST` variable:
```bash
STORYBOOK_RC_HOST=
```
Alternatively, run this command in the `packages/react` directory:
```bash
STORYBOOK_RC_HOST= yarn storybook
```
### Package Development Overview
The project uses a monorepo structure with three key packages: `react`, `auth`, and `api`. Each package fulfills a vital role in the application:
#### React Package Development
The `react` package serves as the main frontend component, having all UI elements and views. It interfaces with the `auth` and `api` packages to manage interactions with the Rocket.Chat server, including API calls and authentication.
To develop and test changes in the `react` package:
1. Navigate to the directory of the `react` package:
```bash
cd packages/react
```
2. Start Storybook to view live changes:
```bash
yarn storybook
```
#### Auth Package Development
To develop and test changes in the `auth` package:
1. Navigate to the `auth` package directory:
```bash
cd packages/auth
```
2. Start the development server:
```bash
yarn dev
```
#### API Package Development
For development in the `api` package:
1. Navigate to the `api` package directory:
```bash
cd packages/api
```
2. Start the development server:
```bash
yarn dev
```
**Development Workflow Notes:**
- The `react` package relies on the `api` package. After making changes to the `api`, rebuild it using `yarn build` in `packages/api`, and then restart the React project.
- Similarly, the `api` package depends on the `auth` package. After making changes to `auth`, rebuild it using `yarn build` in `packages/auth`, and then restart the `api` development environment.
This structured approach facilitates cohesive development and integration across all components of the application.
### Conclusion
This environment offers a complete setup for developing and testing the `EmbeddedChat` component, alongside its `api` and `auth` packages. Feel free to explore and enhance the capabilities of `EmbeddedChat`!
## References
- **Documentation Overview**: For a comprehensive overview of Embedded Chat, including installation, usage, and advanced topics, visit our [Documentation Page](https://rocketchat.github.io/EmbeddedChat/docs/).
Below are specific sections that cover various aspects of Embedded Chat:
- Embedded Chat Development: [EC Development](https://rocketchat.github.io/EmbeddedChat/docs/docs/Development/dev_launch) – Explore development techniques for Embedded Chat.
- Embedded Chat Setup: [Setup Instructions](https://rocketchat.github.io/EmbeddedChat/docs/docs/Usage/embeddedchat_setup) – Start setting up Embedded Chat in your app.
- UI Elements: [Setup & Dev Guide](https://rocketchat.github.io/EmbeddedChat/docs/docs/Development/ui-elements) – Integration and customization of UI elements.
- Layout Editor: [Using the Editor](https://rocketchat.github.io/EmbeddedChat/docs/docs/Usage/layout_editor) – Customize the chat interface with the layout editor.
- EmbeddedChat RC Setup: [Setup Instructions](https://rocketchat.github.io/EmbeddedChat/docs/docs/Usage/ec_rc_setup) – Guide for setting up Embedded Chat RC App.
- Authentication: [Guide](https://rocketchat.github.io/EmbeddedChat/docs/docs/Usage/authentication) – Configure and manage authentication for Embedded Chat.
- Theming Guide: [Guide](https://rocketchat.github.io/EmbeddedChat/docs/docs/Usage/theming) – Guide to theming options and customization.
- Theming Technical: [Technical Overview](https://rocketchat.github.io/EmbeddedChat/docs/docs/Development/theming_technical) – Technical aspects of theming.
### Contributors
