Chaskiq

by chaskiq

GitHub Readme.md

image

Chaskiq

Open Source Messaging Platform for Marketing, Support & Sales

The front line of your customer service.

CI CI CI
Deploy

Main features:

  • Customer Segment Filters with custom attributes support
  • Web Messenger embed
  • Agent's conversation routing
  • Text chat with customizable content blocks support
  • Video Calls !
  • Triggerable conversational bots
  • Mailing campaigns
  • Onboarding tours
  • API integrations - Whatsapp / Twitter DM / Slack / Calendly / Zoom and more!
  • CRM integration - Pipedrive supported
  • Webhooks
  • Help Center system with multilanguage support
  • API support - consumible via GrapqhQL with Oauth authorization

And many features to come

To learn more about the philosophy and goals of the project, visit chaskiq.io.

Embeddable WebChat:

  • A powerful text editor for the chat based in Dante2 Wysiwyg.
  • Animated Gifs.
  • Embeddable Videos from Youtube, Vimeo.
  • Embedable webpages via Oembed protocol.
  • Video Recorder.
  • Video Calls via RTC protocol.
  • Third party apps like Calendly & Zoom.
  • Colorized Code via Prism.js.

image

Dashboard panel

We have designed the dashboard with an extensible & pluggable architecture, you can implement your own dashboard blocks to customize it with external data sources.

Also it can display the visit activity and the conversation performance like reply rate times & response averages.

Help Center

Chaskiq has a powerful article content creator which can serve as a Help Center / Knowledge base system. it can live on a custom domain or in the same webchat for your customer auto assistance.

image

Development

To get your environment setup, follow the community setup guide for your operating system.

  1. If you're on macOS, try the macOS development guide.
  2. If you're on Ubuntu, try the Ubuntu development guide.
  3. If you're on Windows, try the Windows 10 development guide.
  4. If you want to develop on Docker Docker Dev Guide

Before you get started, ensure you have the following minimum versions: Ruby 2.6+, PostgreSQL 10+, Redis 2.6+.

Setting up Chaskiq

If you want to set up a Chaskiq for production use, see our Chaskiq Install Guide.

Requirements

Chaskiq is built for the next 10 years of the Internet, so our requirements are high:

Browsers Tablets Phones Safari 10+ iPad 4+ iOS 10+ Google Chrome 57+ Android 4.4+ Android 4.4+ Internet Explorer 11+ Firefox 52+

Built With

  • Ruby on Rails — Our back end API is a Rails app. It responds to requests RESTfully in JSON.
  • React.js — Our front end is an React.js app that communicates with the Rails Graphql API.
  • PostgreSQL — Our main data store is in Postgres.
  • Redis — We use Redis as a cache and for transient data.

Plus lots of Ruby Gems, a complete list of which is at /master/Gemfile.

Contributing

Chaskiq is 100% free and open source. We encourage and support an active, healthy community that accepts contributions from the public – including you!

The Chaskiq Team

For a complete list of the many individuals that contributed to the design and implementation of Chaskiq, please refer to GitHub's list of contributors.

Copyright / License

Copyright 2019 Chaskiq.

Licensed under the GNU General Public License Version 2.0 (or later); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.