Skip to content

Commit

Permalink
about info
Browse files Browse the repository at this point in the history
  • Loading branch information
edolganov committed May 14, 2015
1 parent c8eb454 commit 8c47d15
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 6 deletions.
40 changes: 34 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
# Live Chat Engine

<!---
The engine for live chats with customers
-->

Open source system for live chats with visitors (customers) in any site.
Contains server-side (chats storing, users and billing management), operators cabinet for chatting and chat form for site's visitors.

*Chat Form on a site:*
![Operators Cabinet](https://raw.githubusercontent.com/edolganov/live-chat-engine/master/extra/images/live-chat-client.png "Chat Form")
![Operators Cabinet](https://raw.githubusercontent.com/edolganov/live-chat-engine/master/extra/images/live-chat-client.png)


*Operators Cabinet:*
![Operators Cabinet](https://raw.githubusercontent.com/edolganov/live-chat-engine/master/extra/images/live-chat-cabinet.png "Operators Cabinet")
![Operators Cabinet](https://raw.githubusercontent.com/edolganov/live-chat-engine/master/extra/images/live-chat-cabinet.png)

## Two work modes
### Software as a Service
Expand All @@ -28,3 +24,35 @@ Other popular examples: [olark](https://www.olark.com/), [livezilla](https://www.
In Tool Mode admin creates accounts, user can be only a operator, no monthly bills. You can use Tool Mode for live chats for single site with own hosting for example.

**Tool mode is not completed yet! Implementation is in progress...**

## Requirements
- Java 8
- PostgreSQL or default H2DB (included to the build)
- Windows (tested on Win7) / Linux (tested on Ubuntu)

## How to build
- download last version
- check Java version (print "java -version" in a console)
- start **build.bat** (win) or **build.sh** (linux)
- on BUILD SUCCESSFUL message see **/build/_servers** dir
- copy all files from **/build/_servers** to your work dir
- run components by **run-all.bat** or **run-all.sh**

## Engine components

### database-h2-server
Included database server by default. Use for tests. For production use PostgreSQL.

### chat-central-server
Server for caches and synchronization.

### chat-front-server
Web server for site and operators online cabinet.

### chat-node-server
Storage for chats accounts.

## Demployment
### Simple deployment scheme
Only one instance of front and node servers:
![Simple deployment scheme](https://raw.githubusercontent.com/edolganov/live-chat-engine/master/extra/images/deploy-scheme-simple.png)
Binary file added extra/images/deploy-scheme-simple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8c47d15

Please sign in to comment.