67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
<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>
|
|
</p>
|
|
|
|
___
|
|
|
|
|
|
|
|
[](https://codeclimate.com/github/chatwoot/chatwoot/maintainability)
|
|
|
|
|
|
|
|
|
|
## Quick Setup
|
|
|
|
### Install JS dependencies
|
|
|
|
``` bash
|
|
yarn install
|
|
```
|
|
|
|
### Install ImageMagik
|
|
|
|
```bash
|
|
brew install imagemagick
|
|
```
|
|
|
|
### Setup rails server
|
|
|
|
```bash
|
|
# install ruby dependencies
|
|
bundle
|
|
|
|
# copy config & update the values in database and application ymls accordingly
|
|
# ref docs for detailed instructions
|
|
cp shared/config/database.yml config/database.yml
|
|
cp shared/config/application.yml config/application.yml
|
|
|
|
# copy frontend env file
|
|
cp .env.sample .env
|
|
|
|
# run db migrations
|
|
bundle exec rake db:create
|
|
bundle exec rake db:reset
|
|
|
|
# fireup the server
|
|
foreman start -f Procfile.dev
|
|
```
|
|
|
|
### Login with credentials
|
|
|
|
```bash
|
|
http://localhost:3000
|
|
user name: larry@google.com
|
|
password: 123456
|
|
```
|
|
|
|
## Detailed documentation
|
|
|
|
Detailed documentation is available at [www.chatwoot.com/docs](https://www.chatwoot.com/docs)
|
|
|
|
## Contributors ✨
|
|
|
|
Thanks goes to all these [wonderful people](https://www.chatwoot.com/docs/contributors):
|
|
|
|
*Chatwoot* © 2017-2019, ThoughtWoot Inc - Released under the MIT License.
|