Chatwoot/README.md

68 lines
1.6 KiB
Markdown
Raw Normal View History

2019-09-05 07:55:41 +00:00
<p align="center">
<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
___
<p align="center">
<a href="https://codeclimate.com/github/chatwoot/chatwoot/maintainability"><img src="https://api.codeclimate.com/v1/badges/80f9e1a7c72d186289ad/maintainability" alt="Maintainability"></a>
<img src="https://img.shields.io/circleci/build/github/chatwoot/chatwoot" alt="CircleCI Badge">
<img src="https://img.shields.io/github/license/chatwoot/chatwoot" alt="License">
<img src="https://img.shields.io/github/commit-activity/m/chatwoot/chatwoot" alt="Commits-per-month"></p>
</p>
2019-10-06 15:47:55 +00:00
![ChatUI progess](./.github/dashboard-screen.png)
2019-10-02 03:41:16 +00:00
## Quick Setup
2019-08-17 20:23:55 +00:00
### Install JS dependencies
``` bash
2019-08-17 18:02:49 +00:00
yarn install
2019-08-17 20:23:55 +00:00
```
### Install ImageMagick
2019-08-17 20:23:55 +00:00
```bash
brew install imagemagick
```
### Setup rails server
2019-08-17 20:23:55 +00:00
```bash
# install ruby dependencies
bundle
# Copy configurations
./configure
2019-08-17 19:14:44 +00:00
2019-08-17 18:02:49 +00:00
# run db migrations
bundle exec rake db:create
bundle exec rake db:reset
2019-08-17 18:02:49 +00:00
# fireup the server
foreman start -f Procfile.dev
```
### Login with credentials
2019-08-28 07:32:31 +00:00
```bash
http://localhost:3000
user name: john@acme.inc
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
## 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
<a href="graphs/contributors"><img src="https://opencollective.com/chatwoot/contributors.svg?width=890&button=false" /></a>
2019-09-05 07:55:41 +00:00
*Chatwoot* &copy; 2017-2019, ThoughtWoot Inc - Released under the MIT License.