-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathMakefile
More file actions
140 lines (113 loc) · 3.89 KB
/
Makefile
File metadata and controls
140 lines (113 loc) · 3.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
.PHONY: help up down build rebuild shell migrate makemigrations test test-cov logs logs-worker logs-beat superuser seed clean prune ps docs docs-serve docs-build docs-deploy bump update-deps add-dep remove-dep
# Default target - show help
help:
@echo "Django Starter Template - Docker Compose Commands"
@echo ""
@echo "Usage: make [target]"
@echo ""
@echo "Service Management:"
@echo " up Start all services (db, redis, backend, worker, beat)"
@echo " down Stop all services"
@echo " build Build Docker image"
@echo " rebuild Rebuild image and restart services"
@echo " ps Show running containers"
@echo ""
@echo "Django Commands:"
@echo " shell Open Django shell"
@echo " migrate Run database migrations"
@echo " makemigrations Create new migrations"
@echo " superuser Create a superuser"
@echo " seed Seed database (20 users + superuser)"
@echo ""
@echo "Testing & Debugging:"
@echo " test Run all tests"
@echo " test-cov Run tests with coverage report"
@echo " logs View backend logs (follow mode)"
@echo " logs-worker View Celery worker logs"
@echo " logs-beat View Celery beat logs"
@echo ""
@echo "Documentation:"
@echo " docs Serve documentation locally (alias for docs-serve)"
@echo " docs-serve Serve documentation with live reload"
@echo " docs-build Build documentation site"
@echo " docs-deploy Deploy documentation to GitHub Pages"
@echo ""
@echo "Version Management:"
@echo " bump Bump patch version in pyproject.toml and urls.py"
@echo ""
@echo "Dependency Management:"
@echo " update-deps Update all dependencies to latest allowed versions"
@echo " add-dep Add a new dependency (usage: make add-dep pkg=package_name)"
@echo " remove-dep Remove a dependency (usage: make remove-dep pkg=package_name)"
@echo ""
@echo "Maintenance:"
@echo " clean Stop services and remove volumes"
@echo " prune Remove unused Docker resources"
# Service Management
up:
docker compose up
down:
docker compose down
build:
docker compose build
rebuild:
docker compose up --build
ps:
docker compose ps
# Django Commands
shell:
docker compose exec backend python manage.py shell
migrate:
docker compose exec backend python manage.py migrate
makemigrations:
docker compose exec backend python manage.py makemigrations
superuser:
docker compose exec backend python manage.py createsuperuser
seed:
docker compose exec backend python manage.py seed --users 20 --superuser --clean
# Testing & Debugging
test:
docker compose exec backend pytest
test-cov:
docker compose exec backend pytest --cov
test-html:
docker compose exec backend pytest --cov --cov-report=html
@echo "Coverage report generated in htmlcov/index.html"
logs:
docker compose logs -f backend
logs-worker:
docker compose logs -f worker
logs-beat:
docker compose logs -f beat
logs-all:
docker compose logs -f
# Documentation
docs: docs-serve
docs-serve:
docker compose exec backend mkdocs serve -a 0.0.0.0:8001
docs-build:
docker compose exec backend mkdocs build
docs-deploy:
@echo "Note: Deployment requires local git credentials"
uv run --with mkdocs-material mkdocs gh-deploy
# Version Management
bump:
uv run python scripts/bump.py
# Dependency Management
update-deps:
uv lock --upgrade
@echo "Lock file updated. Run 'make rebuild' to apply changes."
add-dep:
@if [ -z "$(pkg)" ]; then echo "Usage: make add-dep pkg=package_name"; exit 1; fi
uv add $(pkg)
@echo "Dependency added. Run 'make rebuild' to apply changes."
remove-dep:
@if [ -z "$(pkg)" ]; then echo "Usage: make remove-dep pkg=package_name"; exit 1; fi
uv remove $(pkg)
@echo "Dependency removed. Run 'make rebuild' to apply changes."
# Maintenance
clean:
docker compose down -v
prune:
docker system prune -f
docker volume prune -f