Feat: Backend scaffolding and local dev stack
This commit is contained in:
26
Commands/Local/Dev/backend.just
Normal file
26
Commands/Local/Dev/backend.just
Normal file
@@ -0,0 +1,26 @@
|
||||
project_root := justfile_directory()
|
||||
backend_dir := project_root + "/Backend"
|
||||
|
||||
# Apply embedded database migrations.
|
||||
migrate-up:
|
||||
cd '{{backend_dir}}' && go run ./cmd/migrate up
|
||||
|
||||
# Roll back the most recent embedded database migration.
|
||||
migrate-down:
|
||||
cd '{{backend_dir}}' && go run ./cmd/migrate down
|
||||
|
||||
# Reset all embedded database migrations and reapply from scratch.
|
||||
migrate-reset:
|
||||
cd '{{backend_dir}}' && go run ./cmd/migrate reset
|
||||
|
||||
# Show the embedded database migration status.
|
||||
migrate-status:
|
||||
cd '{{backend_dir}}' && go run ./cmd/migrate status
|
||||
|
||||
# Format backend Go source files.
|
||||
fmt:
|
||||
cd '{{backend_dir}}' && gofmt -w ./cmd ./db ./internal
|
||||
|
||||
# Run backend test suite.
|
||||
test:
|
||||
cd '{{backend_dir}}' && go test ./...
|
||||
14
Commands/Local/Dev/frontend.just
Normal file
14
Commands/Local/Dev/frontend.just
Normal file
@@ -0,0 +1,14 @@
|
||||
project_root := justfile_directory()
|
||||
local_compose := project_root + "/Docker/docker-compose.local.dev.yaml"
|
||||
frontend_dir := project_root + "/Frontend"
|
||||
node_modules_volume := "moku_work_frontend_node_modules"
|
||||
|
||||
# Recreate the frontend node_modules Docker volume.
|
||||
node_modules:
|
||||
docker compose -f '{{local_compose}}' rm -sf frontend >/dev/null 2>&1 || true
|
||||
docker volume rm -f '{{node_modules_volume}}' >/dev/null 2>&1 || true
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate frontend
|
||||
|
||||
# Run the frontend TypeScript check.
|
||||
tsc:
|
||||
cd '{{frontend_dir}}' && pnpm typecheck
|
||||
39
Commands/Local/Dev/mod.just
Normal file
39
Commands/Local/Dev/mod.just
Normal file
@@ -0,0 +1,39 @@
|
||||
stack_runner := justfile_directory() + "/Commands/Local/Dev/scripts/dev-stack.sh"
|
||||
|
||||
mod frontend
|
||||
mod backend
|
||||
|
||||
# Build the combined local development stack assets.
|
||||
build:
|
||||
bash '{{stack_runner}}' build
|
||||
|
||||
# Start the full local development stack in the background.
|
||||
up:
|
||||
bash '{{stack_runner}}' up
|
||||
|
||||
# Build first, then start the full local development stack in the background.
|
||||
start:
|
||||
bash '{{stack_runner}}' start
|
||||
|
||||
# Alias for the main full local development flow.
|
||||
dev: up
|
||||
|
||||
# Stop and remove the local development stack.
|
||||
down:
|
||||
bash '{{stack_runner}}' down
|
||||
|
||||
# Rebuild the full local development stack.
|
||||
rebuild:
|
||||
bash '{{stack_runner}}' rebuild
|
||||
|
||||
# Follow logs for the full local development stack.
|
||||
logs:
|
||||
bash '{{stack_runner}}' logs
|
||||
|
||||
# Restart the full local development stack.
|
||||
restart:
|
||||
bash '{{stack_runner}}' restart
|
||||
|
||||
# Stop the local development stack and remove local images, volumes, and backend dev state.
|
||||
clean:
|
||||
bash '{{stack_runner}}' clean
|
||||
91
Commands/Local/Dev/scripts/backend-stack.sh
Normal file
91
Commands/Local/Dev/scripts/backend-stack.sh
Normal file
@@ -0,0 +1,91 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Path: Commands/Local/Dev/scripts/backend-stack.sh
|
||||
set -euo pipefail
|
||||
|
||||
action=${1:-up}
|
||||
|
||||
script_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)
|
||||
project_root=$(cd -- "$script_dir/../../../.." && pwd)
|
||||
backend_dir="$project_root/Backend"
|
||||
backend_bake="$backend_dir/docker-bake.hcl"
|
||||
env_dir="$project_root/Env"
|
||||
compose_file="$project_root/Docker/docker-compose.local.dev.yaml"
|
||||
runtime_dir="$backend_dir/tmp/dev"
|
||||
backend_image="moku/work-backend:dev"
|
||||
backend_go_pkg_volume="moku_work_backend_go_pkg"
|
||||
backend_go_build_volume="moku_work_backend_go_build"
|
||||
|
||||
services=(web api worker)
|
||||
|
||||
source "$script_dir/docker.sh"
|
||||
source "$script_dir/env.sh"
|
||||
|
||||
build_backend() {
|
||||
cd "$backend_dir"
|
||||
docker buildx bake -f "$backend_bake" dev
|
||||
}
|
||||
|
||||
up_backend() {
|
||||
docker compose -f "$compose_file" up -d --remove-orphans --force-recreate "${services[@]}"
|
||||
}
|
||||
|
||||
down_backend() {
|
||||
docker compose -f "$compose_file" stop "${services[@]}" >/dev/null 2>&1 || true
|
||||
docker compose -f "$compose_file" rm -f "${services[@]}" >/dev/null 2>&1 || true
|
||||
}
|
||||
|
||||
restart_backend() {
|
||||
docker compose -f "$compose_file" restart "${services[@]}"
|
||||
}
|
||||
|
||||
follow_logs() {
|
||||
docker compose -f "$compose_file" logs -f "${services[@]}"
|
||||
}
|
||||
|
||||
clean_runtime() {
|
||||
rm -rf "$runtime_dir"
|
||||
}
|
||||
|
||||
case "$action" in
|
||||
check)
|
||||
ensure_docker 'docker is required for the local backend dev runtime. Install Docker first.'
|
||||
;;
|
||||
build)
|
||||
ensure_docker 'docker is required for the local backend dev runtime. Install Docker first.'
|
||||
build_backend
|
||||
;;
|
||||
up)
|
||||
ensure_docker 'docker is required for the local backend dev runtime. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
up_backend
|
||||
;;
|
||||
down)
|
||||
ensure_docker 'docker is required for the local backend dev runtime. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
down_backend
|
||||
;;
|
||||
restart)
|
||||
ensure_docker 'docker is required for the local backend dev runtime. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
restart_backend
|
||||
;;
|
||||
logs)
|
||||
ensure_docker 'docker is required for the local backend dev runtime. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
follow_logs
|
||||
;;
|
||||
clean)
|
||||
ensure_docker 'docker is required for the local backend dev runtime. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
down_backend
|
||||
remove_docker_image_if_present "$backend_image"
|
||||
remove_docker_volume_if_present "$backend_go_pkg_volume"
|
||||
remove_docker_volume_if_present "$backend_go_build_volume"
|
||||
clean_runtime
|
||||
;;
|
||||
*)
|
||||
printf 'Unsupported backend stack action: %s\n' "$action" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
102
Commands/Local/Dev/scripts/dev-stack.sh
Normal file
102
Commands/Local/Dev/scripts/dev-stack.sh
Normal file
@@ -0,0 +1,102 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Path: Commands/Local/Dev/scripts/dev-stack.sh
|
||||
set -euo pipefail
|
||||
|
||||
action=${1:-up}
|
||||
|
||||
script_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)
|
||||
project_root=$(cd -- "$script_dir/../../../.." && pwd)
|
||||
frontend_dir="$project_root/Frontend"
|
||||
frontend_bake="$frontend_dir/docker-bake.hcl"
|
||||
backend_dir="$project_root/Backend"
|
||||
backend_bake="$backend_dir/docker-bake.hcl"
|
||||
env_dir="$project_root/Env"
|
||||
compose_file="$project_root/Docker/docker-compose.local.dev.yaml"
|
||||
frontend_image="moku/work-frontend:dev"
|
||||
backend_image="moku/work-backend:dev"
|
||||
frontend_volume="moku_work_frontend_node_modules"
|
||||
backend_go_pkg_volume="moku_work_backend_go_pkg"
|
||||
backend_go_build_volume="moku_work_backend_go_build"
|
||||
backend_runtime_dir="$backend_dir/tmp/dev"
|
||||
|
||||
source "$script_dir/docker.sh"
|
||||
source "$script_dir/env.sh"
|
||||
|
||||
build_frontend() {
|
||||
cd "$frontend_dir"
|
||||
docker buildx bake -f "$frontend_bake" dev
|
||||
}
|
||||
|
||||
build_backend() {
|
||||
cd "$backend_dir"
|
||||
docker buildx bake -f "$backend_bake" dev
|
||||
}
|
||||
|
||||
build_images() {
|
||||
build_frontend
|
||||
build_backend
|
||||
}
|
||||
|
||||
up_stack() {
|
||||
docker compose -f "$compose_file" up -d --remove-orphans --force-recreate
|
||||
}
|
||||
|
||||
down_stack() {
|
||||
docker compose -f "$compose_file" down --remove-orphans --volumes
|
||||
}
|
||||
|
||||
follow_logs() {
|
||||
docker compose -f "$compose_file" logs -f
|
||||
}
|
||||
|
||||
clean_stack() {
|
||||
docker compose -f "$compose_file" down --remove-orphans --volumes >/dev/null 2>&1 || true
|
||||
remove_docker_image_if_present "$frontend_image"
|
||||
remove_docker_image_if_present "$backend_image"
|
||||
remove_docker_volume_if_present "$frontend_volume"
|
||||
remove_docker_volume_if_present "$backend_go_pkg_volume"
|
||||
remove_docker_volume_if_present "$backend_go_build_volume"
|
||||
rm -rf "$backend_runtime_dir"
|
||||
}
|
||||
|
||||
start_stack() {
|
||||
build_images
|
||||
up_stack
|
||||
}
|
||||
|
||||
case "$action" in
|
||||
build)
|
||||
ensure_docker 'docker is required for the local development stack. Install Docker first.'
|
||||
build_images
|
||||
;;
|
||||
up|start|rebuild)
|
||||
ensure_docker 'docker is required for the local development stack. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
start_stack
|
||||
;;
|
||||
down)
|
||||
ensure_docker 'docker is required for the local development stack. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
down_stack
|
||||
;;
|
||||
restart)
|
||||
ensure_docker 'docker is required for the local development stack. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
docker compose -f "$compose_file" restart
|
||||
;;
|
||||
logs)
|
||||
ensure_docker 'docker is required for the local development stack. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
follow_logs
|
||||
;;
|
||||
clean)
|
||||
ensure_docker 'docker is required for the local development stack. Install Docker first.'
|
||||
ensure_local_env_file "$env_dir"
|
||||
clean_stack
|
||||
;;
|
||||
*)
|
||||
printf 'Unsupported dev stack action: %s\n' "$action" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
20
Commands/Local/Dev/scripts/docker.sh
Normal file
20
Commands/Local/Dev/scripts/docker.sh
Normal file
@@ -0,0 +1,20 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
ensure_docker() {
|
||||
local error_message=${1:-docker is required. Install Docker first.}
|
||||
|
||||
if ! command -v docker >/dev/null 2>&1; then
|
||||
printf '%s\n' "$error_message" >&2
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
remove_docker_image_if_present() {
|
||||
docker image rm -f "$1" >/dev/null 2>&1 || true
|
||||
}
|
||||
|
||||
remove_docker_volume_if_present() {
|
||||
docker volume rm -f "$1" >/dev/null 2>&1 || true
|
||||
}
|
||||
21
Commands/Local/Dev/scripts/env.sh
Normal file
21
Commands/Local/Dev/scripts/env.sh
Normal file
@@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
ensure_local_env_file() {
|
||||
local env_dir=$1
|
||||
local example_env_file="$env_dir/.env.example"
|
||||
local local_env_file="$env_dir/.env.local"
|
||||
|
||||
if [[ -f "$local_env_file" ]]; then
|
||||
return
|
||||
fi
|
||||
|
||||
if [[ ! -f "$example_env_file" ]]; then
|
||||
printf 'Missing env template: %s\n' "$example_env_file" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
cp "$example_env_file" "$local_env_file"
|
||||
printf 'Created %s from %s\n' "$local_env_file" "$example_env_file"
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
project_root := justfile_directory()
|
||||
frontend_dir := project_root + "/Frontend"
|
||||
frontend_bake := project_root + "/Frontend/docker-bake.hcl"
|
||||
local_compose := project_root + "/Docker/docker-compose.local.dev.yaml"
|
||||
|
||||
# Build the Frontend development image.
|
||||
build:
|
||||
cd '{{frontend_dir}}' && docker buildx bake -f '{{frontend_bake}}' dev
|
||||
|
||||
# Start the local development stack in the background using the current image.
|
||||
up:
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate
|
||||
|
||||
# Build first, then start the local development stack in the background.
|
||||
start: build
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate
|
||||
|
||||
# Alias for the main local development flow.
|
||||
dev: start
|
||||
|
||||
# Stop and remove the local development stack.
|
||||
down:
|
||||
docker compose -f '{{local_compose}}' down --remove-orphans --volumes
|
||||
|
||||
# Rebuild the Frontend development image and recreate the stack.
|
||||
rebuild:
|
||||
cd '{{frontend_dir}}' && docker buildx bake -f '{{frontend_bake}}' dev
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate
|
||||
|
||||
# Follow logs for the local development stack.
|
||||
logs:
|
||||
docker compose -f '{{local_compose}}' logs -f
|
||||
|
||||
# Restart the local development stack.
|
||||
restart:
|
||||
docker compose -f '{{local_compose}}' restart
|
||||
@@ -1,2 +1,2 @@
|
||||
mod dev
|
||||
mod dev "Dev"
|
||||
mod prod
|
||||
|
||||
@@ -1,32 +1,37 @@
|
||||
project_root := justfile_directory()
|
||||
proxy_bake := project_root + "/Proxy/docker-bake.hcl"
|
||||
local_compose := project_root + "/Docker/docker-compose.local.prod.yaml"
|
||||
proxy_image := "moku/work-proxy:local-prod"
|
||||
|
||||
# Build the local production proxy image locally.
|
||||
build:
|
||||
cd '{{project_root}}' && docker buildx bake -f '{{proxy_bake}}' prod
|
||||
cd '{{project_root}}' && docker buildx bake -f '{{proxy_bake}}' prod
|
||||
|
||||
# Start the local production stack in the background using the current image.
|
||||
up:
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate
|
||||
|
||||
# Build first, then start the local production stack in the background.
|
||||
start: build
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate
|
||||
start: build up
|
||||
|
||||
# Rebuild the local production proxy image locally.
|
||||
rebuild:
|
||||
cd '{{project_root}}' && docker buildx bake -f '{{proxy_bake}}' --set '*.no-cache=true' prod
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate
|
||||
cd '{{project_root}}' && docker buildx bake -f '{{proxy_bake}}' --set '*.no-cache=true' prod
|
||||
docker compose -f '{{local_compose}}' up -d --remove-orphans --force-recreate
|
||||
|
||||
# Stop and remove the local production stack.
|
||||
down:
|
||||
docker compose -f '{{local_compose}}' down --remove-orphans --volumes
|
||||
docker compose -f '{{local_compose}}' down --remove-orphans --volumes
|
||||
|
||||
# Follow logs for the local production stack.
|
||||
logs:
|
||||
docker compose -f '{{local_compose}}' logs -f
|
||||
docker compose -f '{{local_compose}}' logs -f
|
||||
|
||||
# Restart the local production stack.
|
||||
restart:
|
||||
docker compose -f '{{local_compose}}' restart
|
||||
docker compose -f '{{local_compose}}' restart
|
||||
|
||||
# Stop the local production stack and remove local images.
|
||||
clean:
|
||||
docker compose -f '{{local_compose}}' down --remove-orphans --volumes
|
||||
docker image rm -f '{{proxy_image}}' >/dev/null 2>&1 || true
|
||||
|
||||
Reference in New Issue
Block a user