mirror of
https://github.com/twentyhq/twenty.git
synced 2026-04-18 05:54:42 -04:00
## Summary Completely rewrites the development environment setup script to be more robust, idempotent, and flexible. The new implementation auto-detects available services (local PostgreSQL/Redis vs Docker), provides multiple operational modes, and includes comprehensive health checks and error handling. ## Key Changes - **Enhanced setup script** (`packages/twenty-utils/setup-dev-env.sh`): - Added auto-detection logic to prefer local services (PostgreSQL 16, Redis) over Docker - Implemented service health checks with retry logic (30s timeout) - Added command-line flags: `--docker` (force Docker), `--down` (stop services), `--reset` (wipe data) - Improved error handling with `set -euo pipefail` and descriptive failure messages - Added helper functions for service detection, startup, and status checking - Fallback to manual `.env` file copying if Nx is unavailable - Enhanced output with clear status messages and usage instructions - **New Docker Compose file** (`packages/twenty-docker/docker-compose.dev.yml`): - Dedicated development infrastructure file (PostgreSQL 16 + Redis 7) - Includes health checks for both services - Configured with appropriate restart policies and volume management - Separate from production compose configuration - **Updated documentation** (`CLAUDE.md`): - Clarified that all environments (CI, local, Claude Code, Cursor) use the same setup script - Documented new command-line flags and their purposes - Noted that CI workflows manage services independently via GitHub Actions - **Updated Cursor environment config** (`.cursor/environment.json`): - Simplified to use the new unified setup script instead of complex inline commands ## Implementation Details The script now follows a clear three-phase approach: 1. **Service startup** — Auto-detects and starts PostgreSQL and Redis (local or Docker) 2. **Database creation** — Creates 'default' and 'test' databases 3. **Environment configuration** — Sets up `.env` files via Nx or direct file copy The auto-detection logic prioritizes local services for better performance while gracefully falling back to Docker if local services aren't available. All operations are idempotent and safe to run multiple times. https://claude.ai/code/session_01UDxa2Kp1ub9tTL3pnpBVFs --------- Co-authored-by: Claude <noreply@anthropic.com>
252 lines
7.8 KiB
Bash
Executable File
252 lines
7.8 KiB
Bash
Executable File
#!/bin/bash
|
|
# =============================================================================
|
|
# Twenty CRM — Development Environment Setup
|
|
# =============================================================================
|
|
# Single entry point for setting up a dev environment. Idempotent.
|
|
#
|
|
# What it does:
|
|
# 1. Starts Postgres + Redis (local services or Docker, auto-detected)
|
|
# 2. Creates 'default' and 'test' databases
|
|
# 3. Copies .env.example -> .env for front and server
|
|
#
|
|
# Usage (from repo root):
|
|
# bash packages/twenty-utils/setup-dev-env.sh # start + configure
|
|
# bash packages/twenty-utils/setup-dev-env.sh --down # stop services
|
|
# bash packages/twenty-utils/setup-dev-env.sh --reset # wipe data + restart
|
|
# bash packages/twenty-utils/setup-dev-env.sh --docker # force Docker mode
|
|
# =============================================================================
|
|
set -euo pipefail
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
REPO_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
|
|
COMPOSE_FILE="$REPO_ROOT/packages/twenty-docker/docker-compose.dev.yml"
|
|
|
|
info() { echo "=> $*"; }
|
|
ok() { echo " done: $*"; }
|
|
fail() { echo " FAIL: $*" >&2; }
|
|
|
|
# --------------- detection helpers ---------------
|
|
has_local_pg() {
|
|
command -v pg_ctlcluster &>/dev/null && pg_lsclusters 2>/dev/null | grep -q "16"
|
|
}
|
|
|
|
has_local_redis() {
|
|
command -v redis-server &>/dev/null
|
|
}
|
|
|
|
can_use_docker() {
|
|
docker compose version &>/dev/null 2>&1
|
|
}
|
|
|
|
pg_is_up() {
|
|
if command -v pg_isready &>/dev/null; then
|
|
pg_isready -h localhost -p 5432 -U postgres -q 2>/dev/null
|
|
elif command -v psql &>/dev/null; then
|
|
PGPASSWORD=postgres psql -h localhost -p 5432 -U postgres -c "SELECT 1" &>/dev/null
|
|
elif can_use_docker && docker compose -f "$COMPOSE_FILE" ps --quiet db 2>/dev/null | grep -q .; then
|
|
docker compose -f "$COMPOSE_FILE" exec -T db pg_isready -U postgres -q 2>/dev/null
|
|
else
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
redis_is_up() {
|
|
if command -v redis-cli &>/dev/null; then
|
|
redis-cli -h localhost -p 6379 ping 2>/dev/null | grep -q PONG
|
|
elif can_use_docker && docker compose -f "$COMPOSE_FILE" ps --quiet redis 2>/dev/null | grep -q .; then
|
|
docker compose -f "$COMPOSE_FILE" exec -T redis redis-cli ping 2>/dev/null | grep -q PONG
|
|
else
|
|
# Portable fallback using bash /dev/tcp (no nc -q dependency)
|
|
timeout 2 bash -c 'exec 3<>/dev/tcp/localhost/6379; echo PING >&3; read -r reply <&3; exec 3>&-; echo "$reply"' 2>/dev/null | grep -q PONG
|
|
fi
|
|
}
|
|
|
|
wait_for_pg() {
|
|
local retries=30
|
|
while ! pg_is_up; do
|
|
retries=$((retries - 1))
|
|
if [ "$retries" -le 0 ]; then fail "PostgreSQL did not start in time"; exit 1; fi
|
|
sleep 1
|
|
done
|
|
}
|
|
|
|
wait_for_redis() {
|
|
local retries=30
|
|
while ! redis_is_up; do
|
|
retries=$((retries - 1))
|
|
if [ "$retries" -le 0 ]; then fail "Redis did not start in time"; exit 1; fi
|
|
sleep 1
|
|
done
|
|
}
|
|
|
|
# --------------- parse flags ---------------
|
|
USE_DOCKER=false
|
|
ACTION="up"
|
|
|
|
while [ $# -gt 0 ]; do
|
|
case "$1" in
|
|
--docker) USE_DOCKER=true ;;
|
|
--down) ACTION="down" ;;
|
|
--reset) ACTION="reset" ;;
|
|
*) echo "Unknown flag: $1"; exit 1 ;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
# --------------- stop ---------------
|
|
stop_docker() {
|
|
if can_use_docker && docker compose -f "$COMPOSE_FILE" ps -a --quiet 2>/dev/null | grep -q .; then
|
|
docker compose -f "$COMPOSE_FILE" down "$@"
|
|
fi
|
|
}
|
|
|
|
stop_local() {
|
|
if has_local_pg; then sudo pg_ctlcluster 16 main stop 2>/dev/null || true; fi
|
|
if has_local_redis && pgrep -x redis-server &>/dev/null; then
|
|
sudo service redis-server stop 2>/dev/null || true
|
|
fi
|
|
}
|
|
|
|
stop_services() {
|
|
if [ "$USE_DOCKER" = true ]; then
|
|
stop_docker "$@"
|
|
else
|
|
stop_docker "$@"
|
|
stop_local
|
|
fi
|
|
}
|
|
|
|
if [ "$ACTION" = "down" ]; then
|
|
info "Stopping dev services..."
|
|
stop_services
|
|
ok "Services stopped"
|
|
exit 0
|
|
fi
|
|
|
|
if [ "$ACTION" = "reset" ]; then
|
|
info "Resetting dev services (wiping data)..."
|
|
# Wipe local Redis data while it's still running
|
|
if [ "$USE_DOCKER" = false ] && has_local_redis && pgrep -x redis-server &>/dev/null; then
|
|
info "Flushing local Redis data..."
|
|
redis-cli flushall 2>/dev/null || true
|
|
fi
|
|
# Wipe local PostgreSQL data while it's still running
|
|
if [ "$USE_DOCKER" = false ] && has_local_pg; then
|
|
info "Dropping local databases..."
|
|
sudo pg_ctlcluster 16 main start 2>/dev/null || true
|
|
wait_for_pg
|
|
sudo -u postgres psql -c 'DROP DATABASE IF EXISTS "default";' 2>/dev/null || true
|
|
sudo -u postgres psql -c 'DROP DATABASE IF EXISTS "test";' 2>/dev/null || true
|
|
fi
|
|
# Stop Docker with -v to remove volumes
|
|
stop_docker -v 2>/dev/null || stop_docker
|
|
# Stop local services
|
|
if [ "$USE_DOCKER" = false ]; then
|
|
stop_local
|
|
fi
|
|
fi
|
|
|
|
# =============================================================================
|
|
# 1. Start services (auto-detect: local > Docker)
|
|
# =============================================================================
|
|
start_pg() {
|
|
if pg_is_up; then
|
|
ok "PostgreSQL already running"
|
|
return
|
|
fi
|
|
|
|
if [ "$USE_DOCKER" = false ] && has_local_pg; then
|
|
info "Starting local PostgreSQL..."
|
|
sudo pg_ctlcluster 16 main start
|
|
wait_for_pg
|
|
sudo -u postgres psql -c "ALTER USER postgres PASSWORD 'postgres';" 2>/dev/null || true
|
|
elif can_use_docker; then
|
|
info "Starting PostgreSQL via Docker..."
|
|
docker compose -f "$COMPOSE_FILE" up -d db
|
|
wait_for_pg
|
|
else
|
|
fail "No PostgreSQL available. Install PostgreSQL 16 or Docker."
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
start_redis() {
|
|
if redis_is_up; then
|
|
ok "Redis already running"
|
|
return
|
|
fi
|
|
|
|
if [ "$USE_DOCKER" = false ] && has_local_redis; then
|
|
info "Starting local Redis..."
|
|
sudo service redis-server start 2>/dev/null || redis-server --daemonize yes 2>/dev/null || true
|
|
wait_for_redis
|
|
elif can_use_docker; then
|
|
info "Starting Redis via Docker..."
|
|
docker compose -f "$COMPOSE_FILE" up -d redis
|
|
wait_for_redis
|
|
else
|
|
fail "No Redis available. Install Redis or Docker."
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
if [ "$USE_DOCKER" = true ]; then
|
|
info "Starting services via Docker Compose..."
|
|
docker compose -f "$COMPOSE_FILE" up -d
|
|
wait_for_pg
|
|
wait_for_redis
|
|
else
|
|
start_pg
|
|
start_redis
|
|
fi
|
|
|
|
ok "PostgreSQL on localhost:5432"
|
|
ok "Redis on localhost:6379"
|
|
|
|
# =============================================================================
|
|
# 2. Create databases
|
|
# =============================================================================
|
|
info "Creating databases..."
|
|
run_psql() {
|
|
if command -v psql &>/dev/null; then
|
|
PGPASSWORD=postgres psql -h localhost -p 5432 -U postgres -d postgres -c "$1" 2>/dev/null || true
|
|
elif can_use_docker && docker compose -f "$COMPOSE_FILE" ps --quiet db 2>/dev/null | grep -q .; then
|
|
docker compose -f "$COMPOSE_FILE" exec -T db psql -U postgres -d postgres -c "$1" 2>/dev/null || true
|
|
else
|
|
fail "No psql client available and no Docker db container running"
|
|
return 1
|
|
fi
|
|
}
|
|
run_psql 'CREATE DATABASE "default";'
|
|
run_psql 'CREATE DATABASE "test";'
|
|
ok "Databases 'default' and 'test' ready"
|
|
|
|
# =============================================================================
|
|
# 3. Environment files (via Nx when available, fallback to cp)
|
|
# =============================================================================
|
|
info "Setting up .env files..."
|
|
cd "$REPO_ROOT"
|
|
|
|
if command -v npx &>/dev/null && [ -d node_modules ]; then
|
|
npx nx reset:env twenty-front
|
|
npx nx reset:env twenty-server
|
|
else
|
|
for pkg in twenty-front twenty-server; do
|
|
src="packages/$pkg/.env.example"
|
|
dst="packages/$pkg/.env"
|
|
if [ -f "$src" ] && [ ! -f "$dst" ]; then
|
|
cp "$src" "$dst"
|
|
ok "$pkg/.env created"
|
|
fi
|
|
done
|
|
fi
|
|
|
|
# =============================================================================
|
|
echo ""
|
|
echo "Dev environment ready."
|
|
echo ""
|
|
echo " yarn start # start everything"
|
|
echo " npx nx start twenty-front # frontend -> http://localhost:3001"
|
|
echo " npx nx start twenty-server # backend -> http://localhost:3000"
|
|
echo ""
|