2019-09-05 07:55:41 +00:00
|
|
|
<p align="center">
|
2019-10-06 03:53:24 +00:00
|
|
|
<img src=".github/woot-logo.svg" alt="Woo-logo" width="240">
|
|
|
|
<div align="center">Opensource alternative to Intercom, Zendesk, Drift, Crisp etc.</div>
|
2019-09-05 07:55:41 +00:00
|
|
|
</p>
|
2019-10-06 03:53:51 +00:00
|
|
|
|
2019-08-28 07:32:31 +00:00
|
|
|
___
|
|
|
|
|
|
|
|
![CircleCI Badge](https://img.shields.io/circleci/build/github/chatwoot/chatwoot)
|
|
|
|
![License](https://img.shields.io/github/license/chatwoot/chatwoot)
|
|
|
|
[![Maintainability](https://api.codeclimate.com/v1/badges/80f9e1a7c72d186289ad/maintainability)](https://codeclimate.com/github/chatwoot/chatwoot/maintainability)
|
|
|
|
![Commits-per-month](https://img.shields.io/github/commit-activity/m/chatwoot/chatwoot)
|
2019-10-06 15:47:55 +00:00
|
|
|
|
|
|
|
![ChatUI progess](./.github/dashboard-screen.png)
|
2019-08-14 09:48:44 +00:00
|
|
|
|
2019-10-02 03:41:16 +00:00
|
|
|
## Quick Setup
|
2019-08-14 09:48:44 +00:00
|
|
|
|
2019-08-17 20:23:55 +00:00
|
|
|
### Install JS dependencies
|
|
|
|
|
2019-08-14 09:48:44 +00:00
|
|
|
``` bash
|
2019-08-17 18:02:49 +00:00
|
|
|
yarn install
|
2019-08-17 20:23:55 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
### Install ImageMagik
|
|
|
|
|
|
|
|
```bash
|
|
|
|
brew install imagemagick
|
|
|
|
```
|
|
|
|
|
|
|
|
### Setup rails server
|
2019-08-14 09:48:44 +00:00
|
|
|
|
2019-08-17 20:23:55 +00:00
|
|
|
```bash
|
2019-08-14 09:48:44 +00:00
|
|
|
# install ruby dependencies
|
|
|
|
bundle
|
|
|
|
|
2019-10-22 05:37:29 +00:00
|
|
|
# Copy configurations
|
|
|
|
./configure
|
2019-08-17 19:14:44 +00:00
|
|
|
|
2019-08-17 18:02:49 +00:00
|
|
|
# run db migrations
|
2019-08-19 08:19:57 +00:00
|
|
|
bundle exec rake db:create
|
|
|
|
bundle exec rake db:reset
|
2019-08-17 18:02:49 +00:00
|
|
|
|
2019-08-14 09:48:44 +00:00
|
|
|
# fireup the server
|
2019-08-19 08:19:57 +00:00
|
|
|
foreman start -f Procfile.dev
|
2019-08-14 09:48:44 +00:00
|
|
|
```
|
2019-08-19 08:19:57 +00:00
|
|
|
|
|
|
|
### Login with credentials
|
2019-08-28 07:32:31 +00:00
|
|
|
|
|
|
|
```bash
|
2019-08-19 08:19:57 +00:00
|
|
|
http://localhost:3000
|
2019-10-20 10:49:12 +00:00
|
|
|
user name: john@acme.inc
|
2019-08-19 08:19:57 +00:00
|
|
|
password: 123456
|
2019-08-28 07:32:31 +00:00
|
|
|
```
|
|
|
|
|
2019-10-13 04:28:32 +00:00
|
|
|
## Detailed documentation
|
2019-10-02 03:41:16 +00:00
|
|
|
|
2019-10-09 12:28:14 +00:00
|
|
|
Detailed documentation is available at [www.chatwoot.com/docs](https://www.chatwoot.com/docs)
|
2019-10-02 03:41:16 +00:00
|
|
|
|
2019-09-05 06:46:56 +00:00
|
|
|
## Contributors ✨
|
|
|
|
|
2019-10-13 04:28:32 +00:00
|
|
|
Thanks goes to all these [wonderful people](https://www.chatwoot.com/docs/contributors):
|
2019-09-05 07:55:41 +00:00
|
|
|
|
|
|
|
*Chatwoot* © 2017-2019, ThoughtWoot Inc - Released under the MIT License.
|