Chatwoot/README.md

69 lines
1.8 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-08-28 07:32:31 +00:00
___
![CircleCI Badge](https://img.shields.io/circleci/build/github/chatwoot/chatwoot)
![Dependencies](https://img.shields.io/david/chatwoot/chatwoot)
![Github Issues](https://img.shields.io/github/issues/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)
![ChatUI progess](https://chatwoot.com/images/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 ImageMagik
```bash
brew install imagemagick
```
### Setup rails server
2019-08-17 20:23:55 +00:00
```bash
# install ruby dependencies
bundle
2019-08-17 20:32:00 +00:00
# copy config
2019-08-17 18:03:21 +00:00
cp shared/config/database.yml config/database.yml
2019-08-17 20:32:00 +00:00
cp shared/config/application.yml config/application.yml
2019-08-17 18:02:49 +00:00
2019-08-17 19:14:44 +00:00
# copy frontend env file
cp .env.sample .env
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: larry@google.com
password: 123456
2019-08-28 07:32:31 +00:00
```
2019-10-02 03:41:16 +00:00
### Detailed documentation
Detailed documentation is available at [docs.chatwoot.com](https://docs.chatwoot.com)
2019-10-02 03:41:16 +00:00
## Contributors ✨
Thanks goes to all these [wonderful people](https://github.com/chatwoot/chatwoot/blob/master/docs/contributors.md):
2019-09-05 07:55:41 +00:00
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
*Chatwoot* &copy; 2017-2019, ThoughtWoot Inc - Released under the MIT License.