KumiSystems/Chatwoot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Chatwoot/README.md

67 lines
3.8 KiB
Markdown
Raw Normal View History

Fix pixelated logo in readme
2019-09-05 07:55:41 +00:00
<p align="center">
Updated docs for docker configuration (#322)
2019-11-28 19:27:49 +00:00
<img src="https://storage.googleapis.com/chatwoot-assets/woot-logo.svg" alt="Woot-logo" width="240">
Add background story (#269)
2019-11-23 18:14:44 +00:00
<div align="center">A simple and elegant live chat software</div>
<div align="center">An opensource alternative to Intercom, Zendesk, Drift, Crisp etc.</div>
Fix pixelated logo in readme
2019-09-05 07:55:41 +00:00
</p>
Update README.md
2019-10-06 03:53:51 +00:00
Display deploy to heroku button more prominently in Readme (#285)
2019-11-26 05:47:34 +00:00
<p align="center">
<a href="https://heroku.com/deploy?template=https://github.com/chatwoot/chatwoot/tree/master" alt="Deploy to Heroku">
Updated docs for docker configuration (#322)
2019-11-28 19:27:49 +00:00
<img alt="Deploy" src="https://www.herokucdn.com/deploy/button.svg"/>
Display deploy to heroku button more prominently in Readme (#285)
2019-11-26 05:47:34 +00:00
</a>
</p>
Update readme
2019-08-28 07:32:31 +00:00
___
Update docs to use open collective (#200)
2019-11-04 07:19:01 +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">
[Chore] Add docker build status to repo #287 ref: #287
2019-11-26 09:19:01 +00:00
<a href="https://hub.docker.com/r/chatwoot/chatwoot/"><img src="https://img.shields.io/docker/cloud/build/chatwoot/chatwoot" alt="Docker Build Badge"></a>
Update docs to use open collective (#200)
2019-11-04 07:19:01 +00:00
<img src="https://img.shields.io/github/license/chatwoot/chatwoot" alt="License">
Add background story (#269)
2019-11-23 18:14:44 +00:00
<img src="https://img.shields.io/github/commit-activity/m/chatwoot/chatwoot" alt="Commits-per-month">
<img src="https://img.shields.io/discord/647412545203994635" alt="Discord">
<a href="https://discord.gg/cJXdrwS"><img src="https://img.shields.io/badge/chat-Discord-violet?logo=discord" alt="Chat on Discord"></a>
Update docs to use open collective (#200)
2019-11-04 07:19:01 +00:00
</p>
Add missing screenshot
2019-10-06 15:47:55 +00:00
Updated docs for docker configuration (#322)
2019-11-28 19:27:49 +00:00
![ChatUI progess](https://storage.googleapis.com/chatwoot-assets/dashboard-screen.png)
Initial Commit Co-authored-by: Subin <subinthattaparambil@gmail.com> Co-authored-by: Manoj <manojmj92@gmail.com> Co-authored-by: Nithin <webofnithin@gmail.com>
2019-08-14 09:48:44 +00:00
Add background story (#269)
2019-11-23 18:14:44 +00:00
## Background
Chatwoot is a customer support tool for instant messaging channels which can help businesses to provide exceptional customer support. The development of Chatwoot started in 2016 and it failed to succeed as a business and eventually shut the shop in 2017. During 2019 #Hacktoberfest, the maintainers decided to make it opensource instead of letting the code rust in a private repo. With a pleasant surprise, Chatwoot became a trending project on Hacker News and best of all, got lots of love from the community.
Now, a failed project is back on track and the prospects are looking great. The team is back to working on the project and we are building it in the open. Thanks to the ideas and contributions from the community.
🔥Docker and environment variables cleanup (#270) * Added dotenv-rails gem to manage environment variables * Added dotenv-rails gem to manage environment variables * Removed figaro which was used earlier for this purpose * Standardized variable names * Changed all env variables to be upper case. This included changes in files referencing env variables. * Added example env file with all variables set to empty value * Removed the earlier setup of copying application.yml and database.yml and the scripts and documentation associated to this * Docker setup * Added docker file for building the docker images * Added entrypoint.sh script which is referenced inside the Docker image * Cloned the Procfile for development using docker which has slight change compared to regular procfile * Added the docker-compose.yml which has 3 service's configuration, postgres, redis and chatwoot server and a mounted volume for postgres * Added docker related info to documentation * Added the docker setup info in the documentation * Added info for using`rbenv` instead of rvm for managing ruby versions * Updated the documentation for environment variables to have one about `dotenv-rails` gem and removed the documentation about the old copy paste method used by figaro * Changing the postgres database, username and password as environment variables * Removed database.yml from gitignore * Made the postgres databse, username and password as environemnt variables * Added this in documentation * Added a quick setup page * Added quick setup page * Removed the docs from README and added link to the docs in website * Removed the figaro related things from circle.ci config * Adding external volume for redis in docker compose * Added instructions for adding the redis volume in docs
2019-11-23 19:57:39 +00:00
## Documentation
Initial Commit Co-authored-by: Subin <subinthattaparambil@gmail.com> Co-authored-by: Manoj <manojmj92@gmail.com> Co-authored-by: Nithin <webofnithin@gmail.com>
2019-08-14 09:48:44 +00:00
🔥Docker and environment variables cleanup (#270) * Added dotenv-rails gem to manage environment variables * Added dotenv-rails gem to manage environment variables * Removed figaro which was used earlier for this purpose * Standardized variable names * Changed all env variables to be upper case. This included changes in files referencing env variables. * Added example env file with all variables set to empty value * Removed the earlier setup of copying application.yml and database.yml and the scripts and documentation associated to this * Docker setup * Added docker file for building the docker images * Added entrypoint.sh script which is referenced inside the Docker image * Cloned the Procfile for development using docker which has slight change compared to regular procfile * Added the docker-compose.yml which has 3 service's configuration, postgres, redis and chatwoot server and a mounted volume for postgres * Added docker related info to documentation * Added the docker setup info in the documentation * Added info for using`rbenv` instead of rvm for managing ruby versions * Updated the documentation for environment variables to have one about `dotenv-rails` gem and removed the documentation about the old copy paste method used by figaro * Changing the postgres database, username and password as environment variables * Removed database.yml from gitignore * Made the postgres databse, username and password as environemnt variables * Added this in documentation * Added a quick setup page * Added quick setup page * Removed the docs from README and added link to the docs in website * Removed the figaro related things from circle.ci config * Adding external volume for redis in docker compose * Added instructions for adding the redis volume in docs
2019-11-23 19:57:39 +00:00
Detailed documentation is available at [www.chatwoot.com/docs](https://www.chatwoot.com/docs).
Move image upload to S3
2019-08-17 20:23:55 +00:00
🔥Docker and environment variables cleanup (#270) * Added dotenv-rails gem to manage environment variables * Added dotenv-rails gem to manage environment variables * Removed figaro which was used earlier for this purpose * Standardized variable names * Changed all env variables to be upper case. This included changes in files referencing env variables. * Added example env file with all variables set to empty value * Removed the earlier setup of copying application.yml and database.yml and the scripts and documentation associated to this * Docker setup * Added docker file for building the docker images * Added entrypoint.sh script which is referenced inside the Docker image * Cloned the Procfile for development using docker which has slight change compared to regular procfile * Added the docker-compose.yml which has 3 service's configuration, postgres, redis and chatwoot server and a mounted volume for postgres * Added docker related info to documentation * Added the docker setup info in the documentation * Added info for using`rbenv` instead of rvm for managing ruby versions * Updated the documentation for environment variables to have one about `dotenv-rails` gem and removed the documentation about the old copy paste method used by figaro * Changing the postgres database, username and password as environment variables * Removed database.yml from gitignore * Made the postgres databse, username and password as environemnt variables * Added this in documentation * Added a quick setup page * Added quick setup page * Removed the docs from README and added link to the docs in website * Removed the figaro related things from circle.ci config * Adding external volume for redis in docker compose * Added instructions for adding the redis volume in docs
2019-11-23 19:57:39 +00:00
You can find the quick setup docs [here](https://www.chatwoot.com/docs/quick-setup).
Add docs.chatwoot.com link in Readme
2019-10-02 03:41:16 +00:00
Docs: Add brancing model (#410)
2020-01-08 17:40:46 +00:00
## Branching model
We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model. The base branch is `develop`.
If you are looking for a stable version, please use the `master` or tags labelled as `v1.x.x`.
[#260] One click deploy to heroku (#275) * [#260] One click deploy to heroku * Added app.json file for Heroku deployment * Made changes in Procfile to accept the PORT as env variable * Added the one click button in README.md * Change readme and link * Alignment of button in Readme * Changing redis to free plan * Removed node-js build-pack * Changed the post-deploy script to be rake db:migrate * Removed web concurrency variable from app.json for heroku * Changed the link to chatwoot logo referenced in app.json * Changed postdeploy hook * Changed logo to be raw content from github * Changed the SMTP variables * Added optional conditional for sending mail * Changed the naming of SMTP variables * Having logo as base 64 encoded image for heroku deploy page * Fixed key not found error for SMTP variables * Correcting the specs for conversation assignment mailer * Spec rubocop fixes * Spec rubocop fixes * Added the link to master for heroku app.json
2019-11-24 11:49:14 +00:00
## Heroku one-click deploy
Deploying chatwoot to heroku, it's a breeze. It's as simple as clicking this button.
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/chatwoot/chatwoot/tree/master)
[#311] Added link to env variables documentation (#312) * Added link to env variables documentation right below the Heroku one click deploy button so that people dont get confused with broken app on deploying without the env variables set correctly
2019-11-27 08:36:39 +00:00
Follow this [link](https://www.chatwoot.com/docs/environment-variables) to understand setting the correct environment variables for the app to work with all the features. There might be breakages if you do not set the relevant environment variables. This applies to deploying the docker image as well.
Updated docs for docker configuration (#322)
2019-11-28 19:27:49 +00:00
## Docker
Updated Docker documentation * Removed the links to docker hub
2020-02-23 17:41:11 +00:00
Follow our [docker development guide](https://www.chatwoot.com/docs/installation-guide-docker) to develop and debug the application using `docker-compose`.
Updated docs for docker configuration (#322)
2019-11-28 19:27:49 +00:00
[Enhancement] Docker support Debugging (byebug & pry) and receive emails to MailHog via smtp (#371) * updated development docker setup * turned on yarn integrity check * create test docker compose and update development dockerfile * create docker Readme.md file * fix README.md file * create docker-copmose and dockerfile for production/staging environment setup * added mailhog to catch email * remove yarn integrity check in development mode! * Update Readme.md file to support mailhog inbox * update link to docker development guide from mail README * remove .env.development and use .env.example for docker as .env.development was mixing with circleci config * make the dockerfile configurable like before * update docker-compose as per suggesion in PR * create docker setup docs * Revert accidental deletion * fix: typo for branding consistency * fix typo * update the code as per recommendation in PR * remove package-lock and add gitignore * fix vulnerability AND update env for tests to pass * Fix yarn integrity check across different docker services * update code based on rubocop and PR suggestions * remove redundant test docker-compose and dockerfile * update rails entrypoint, update docs and Gemfile * [Rubocop] order Gemfile alphabetically * Reordering Gemfile
2019-12-22 17:23:18 +00:00
Follow our [environment variables](https://www.chatwoot.com/docs/environment-variables/) guide to setup environment for Docker.
docs: add pranavrajs as a contributor (#27) * docs: update README.md * docs: create .all-contributorsrc
2019-09-05 06:46:56 +00:00
## Contributors ✨
[docs] Update contributors list (#136)
2019-10-13 04:28:32 +00:00
Thanks goes to all these [wonderful people](https://www.chatwoot.com/docs/contributors):
Fix pixelated logo in readme
2019-09-05 07:55:41 +00:00
Update contributors link (#220) * update Readme.md Fix the anchor tag of contributors * update contributors.md Fix the anchor tag redirecting to 404 page
2019-11-18 08:46:35 +00:00
<a href="https://github.com/chatwoot/chatwoot/graphs/contributors"><img src="https://opencollective.com/chatwoot/contributors.svg?width=890&button=false" /></a>
Update docs to use open collective (#200)
2019-11-04 07:19:01 +00:00
Docs: Update year in license file (#401)
2020-01-02 06:57:22 +00:00
*Chatwoot* &copy; 2017-2020, ThoughtWoot Inc - Released under the MIT License.
Reference in a new issue Copy permalink