add intro documentation and user guide

2025-05-29 19:29:32 +05:30
parent f429db89b4
commit 7808634432
203 changed files with 8020 additions and 7794 deletions
@@ -0,0 +1,115 @@
+---
+title: Make Commands Setup
+description: Speed up your local development workflow with Make commands for Chatwoot.
+sidebarTitle: Make Setup
+---
+
+# 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:
+
+```bash
+git clone https://github.com/chatwoot/chatwoot.git
+cd chatwoot
+```
+
+## Install Ruby & JavaScript dependencies
+
+Install Ruby and JavaScript dependencies using the following command. This command runs Bundler and pnpm:
+
+```bash
+make burn
+```
+
+## Run database migrations
+
+Apply necessary database schema changes to your development environment by running the following command:
+
+```bash
+make db
+```
+
+## Run database seed
+
+Load some seed data to your development environment for testing by running the following command:
+
+```bash
+make db_seed
+```
+
+## Run dev server using Overmind
+
+Start the development server using Overmind, a process manager that can run multiple processes concurrently:
+
+```bash
+make run
+```
+
+## 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:
+
+```bash
+make force_run
+```
+
+## 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:
+
+```bash
+make debug
+```
+
+## Debug worker
+
+To debug the worker, use the following command:
+
+```bash
+make debug_worker
+```
+
+## Get Rails console
+
+Access the Rails console, which provides an interactive environment for interacting with the Chatwoot application:
+
+```bash
+make console
+```
+
+## Build Docker image
+
+Build the Docker image for the Chatwoot project:
+
+```bash
+make docker
+```
+
+## Workflow after pulling in the latest changes from `develop`
+
+To update your development environment after pulling the latest changes from the `develop` branch, follow these steps:
+
+```bash
+make burn     # Install dependencies
+
+make db       # Run migrations
+
+make run      # Start the server
+```
+
+## Getting Help
+
+If you encounter issues with Make commands:
+
+- **Makefile Documentation**: Check the project's `Makefile` for available commands
+- **Overmind Documentation**: [https://github.com/DarthSim/overmind](https://github.com/DarthSim/overmind)
+- **Chatwoot Issues**: [GitHub Issues](https://github.com/chatwoot/chatwoot/issues)
+- **Community Support**: [Discord](https://discord.com/invite/cJXdrwS)
+
+---
+
+Your Make-based development workflow is now ready for efficient Chatwoot development! 🚀