https://github.com/chat21/chat21-web-widget
Chat widget built on top of Firebase/MQTT to emebd chat features into your web/mobile apps.
https://github.com/chat21/chat21-web-widget
angular bot customer-support firebase livechat messaging widget
Last synced: about 1 month ago
JSON representation
Chat widget built on top of Firebase/MQTT to emebd chat features into your web/mobile apps.
- Host: GitHub
- URL: https://github.com/chat21/chat21-web-widget
- Owner: chat21
- License: mit
- Created: 2017-10-04T21:59:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T13:52:49.000Z (about 2 years ago)
- Last Synced: 2025-03-25T08:16:58.418Z (about 2 months ago)
- Topics: angular, bot, customer-support, firebase, livechat, messaging, widget
- Language: TypeScript
- Homepage: http://www.tiledesk.com
- Size: 12.3 MB
- Stars: 94
- Watchers: 10
- Forks: 75
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/%40chat21%2Fchat21-web-widget)
# chat21-web-widget
> ***🚀 Do you want to install Tiledesk on your server with just one click?***
>
> ***Use [Docker Compose Tiledesk installation](https://github.com/Tiledesk/tiledesk-deployment/blob/master/docker-compose/README.md) guide***
Chat21-web-widget is a Free Live Chat Widget built on Firebase with Angular5 that lets you support and chat with visitors and customers on your website.
More information about web widget here : http://www.tiledesk.com
With Chat21-web-widget you can:
* Invite your website visitors to share feedback and suggestions to better understand their needs.
* Answer questions from website visitors instantly to increase trust
* Add a code snippet to your website easly
* It's a HTML5 widget built with Google Firebase, Angular5 and Bootstrap
# Features
* Send a direct message to a preset user
* Receive realtime support from your team
* Form to enter the chat sentiment
* Configure the widget with company logo and colors
* Chat21 Web Widget is free and open source.
# Prerequisites #
* Install Git
* Install Angular CLI with `npm install -g @angular/cli`. More info here https://github.com/angular/angular-cli#installation
* Create a Firebase project. Create one free on `https://firebase.google.com`
* "Chat21 Firebase cloud functions" installed. Instructions:`https://github.com/chat21/chat21-cloud-functions`
# Run Tiledesk with Docker Compose
Do you want to install all the Tiledesk components on your server with just one click?
Use [Docker Compose Tiledesk installation guide](https://github.com/Tiledesk/tiledesk-deployment/blob/master/docker-compose/README.md)
# Installation
* Clone the repository from master (or use a tagged release) with command: ```git clone https://github.com/chat21/chat21-web-widget ```
* Move to the downloaded project path ```cd ```
* Build running: `npm install`
## Dev configuration
Configure the environment.ts file in `src/environments/`.
Use the Firebase configuration file from your Firebase project to correctly configure the 'firebase' section.
#### environment.ts
```typescript
export const environment = {
production: true,
version: require('../../package.json').version,
remoteConfig: false, // for performance don't load settings from remote
remoteConfigUrl: '/widget-config.json',
loadRemoteTranslations: true,
remoteTranslationsUrl: 'https:///',
chatEngine: "mqtt", // OR YOUR CUSTOM CHAT ENGINE
updloaEngine: "native", // OR YOUR CUSTOM UPLOAD ENGINE
fileUploadAccept:"*/*",
logLevel: '',
firebaseConfig: {
apiKey: '123ABC..',
authDomain: 'XYZ.firebaseapp.com',
databaseURL: 'https://XYZ.firebaseio.com',
projectId: 'XYZ',
storageBucket: 'XYZ.appspot.com',
messagingSenderId: '123456',
appId: "CHANGEIT",
tenant: 'tilechat',
},
chat21Config: {
appId: 'tilechat',
MQTTendpoint: 'mqtt://',
APIendpoint: 'http://'
},
apiUrl: 'https:///',
baseImageUrl: 'https:///',
defaultLang : 'en',
storage_prefix : 'widget_sv5',
authPersistence: 'LOCAL',
supportMode: true,
};
```
* `logLevel`: The Chat21-ionic supports 4 log levels. The order is as follows:
`Error < Warn < Info < Debug`
* `fileUploadAccept`: The Chat21-ionic allows you to manage the type of files that can be uploaded. By default, all file types are accepted.
### RUN in dev
Run the app with `ng serve`
## Prod configuration
For production installation, configure the environment.prod.ts file in `src/environments/`.
#### environment.prod.ts
```typescript
export const environment = {
production: true,
...
};
```
# Build for production
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
Build for production with : `ng build --prod --base-href --output-hashing none`
# Deploy
## Deploy to a Web Server
Copy the content of the dist folder to your Web Server (for example Apache or Nginx)
## Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Widget in action
You can see a configuration of this widget in action on 'https://www.tiledesk.com'
# Deploy
## Deploy to a web Server
Copy the content of the dist folder to your Web Server (for example Apache or Nginx)
## Deploy to AWS S3 (Optional)
Run : `aws s3 sync . s3://tiledesk-widget`
Or With a different AWS Profile:
Run : `aws --profile f21 s3 sync . s3://tiledesk-widget`
If you use AWS Cloud Front enable gzip compression.
# Run with docker
To run Chat21-ionic on port 8080 run:
```
curl https://raw.githubusercontent.com/chat21/chat21-web-widget/master/env.sample --output .env
nano .env #configure .env file properly
docker run -p 4200:80 --env-file .env chat21/chat21-web-widget
```