Make Commands Setup

Speed up your local development workflow with Make commands for Chatwoot.

Speed up your local development with Make

Speed up your local development workflow with make commands for Chatwoot.

Clone the repo and cd to the Chatwoot directory

Clone the repository and navigate to the Chatwoot directory:

Install Ruby & JavaScript dependencies

Install Ruby and JavaScript dependencies using the following command. This command runs Bundler and pnpm:

Run database migrations

Apply necessary database schema changes to your development environment by running the following command:

Run database seed

Load some seed data to your development environment for testing by running the following command:

Run dev server using Overmind

Start the development server using Overmind, a process manager that can run multiple processes concurrently:

Force run if ./.overmind.sock file exists

If the make run command fails due to the existence of a ./.overmind.sock file, you can try using the following command:

Debug - Attach to backend via Overmind tmux session

For debugging purposes, you can attach to the backend via the Overmind tmux session using the following command:

Debug worker

To debug the worker, use the following command:

Get Rails console

Access the Rails console, which provides an interactive environment for interacting with the Chatwoot application:

Build Docker image

Build the Docker image for the Chatwoot project:

Workflow after pulling in the latest changes fromdevelop

To update your development environment after pulling the latest changes from the develop branch, follow these steps:

Getting Help

If you encounter issues with Make commands:

Your Make-based development workflow is now ready for efficient Chatwoot development! 🚀

Built with

Show your support! Star us on GitHub ⭐️