helpful-tools-v2/Makefile at main · susamn/helpful-tools-v2 · GitHub

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
# Makefile for Helpful Tools v2

# Configuration
VENV_DIR := .venv
PYTHON := $(VENV_DIR)/bin/python
PIP := $(VENV_DIR)/bin/pip
PYTEST := $(VENV_DIR)/bin/pytest
NPM := npm
PORT := 8000

# Colors for terminal output
YELLOW := \033[1;33m
GREEN := \033[1;32m
RED := \033[1;31m
RESET := \033[0m

.PHONY: all help install setup run start stop restart test test-backend test-frontend lint format clean build

# Default target
all: help

# Help command to list available targets
help:
	@echo "$(YELLOW)Helpful Tools v2 Management$(RESET)"
	@echo "Usage: make [target]"
	@echo ""
	@echo "$(GREEN)Development:$(RESET)"
	@echo "  install        Install all backend and frontend dependencies"
	@echo "  run            Run the server in the foreground (for development)"
	@echo "  start          Start the server in the background"
	@echo "  stop           Stop the background server"
	@echo "  restart        Restart the background server"
	@echo ""
	@echo "$(GREEN)Testing & Quality:$(RESET)"
	@echo "  test           Run all tests (backend and frontend)"
	@echo "  test-backend   Run Python unit and integration tests"
	@echo "  test-frontend  Run JavaScript tests with Jest"
	@echo "  lint           Check code style (flake8 for Python)"
	@echo "  format         Format code (black for Python, prettier for JS)"
	@echo ""
	@echo "$(GREEN)Maintenance:$(RESET)"
	@echo "  clean          Remove temporary files and caches"
	@echo "  build          Simulate a build (install deps + run tests)"

# --- Installation ---

$(VENV_DIR):
	@echo "$(YELLOW)Creating virtual environment...$(RESET)"
	python3 -m venv $(VENV_DIR)

install: $(VENV_DIR)
	@echo "$(YELLOW)Installing Backend Dependencies...$(RESET)"
	$(PIP) install --upgrade pip
	$(PIP) install -r requirements.txt
	@# Install extra dev tools if not in requirements
	$(PIP) install flake8 black
	@echo "$(YELLOW)Installing Frontend Dependencies...$(RESET)"
	$(NPM) install
	@echo "$(GREEN)Installation Complete!$(RESET)"

setup: install

# --- Execution ---

run:
	@echo "$(YELLOW)Starting Server on port $(PORT)...$(RESET)"
	$(PYTHON) app.py --port $(PORT)

start:
	@echo "$(YELLOW)Starting Background Server...$(RESET)"
	./quick-start.sh start $(PORT)

stop:
	@echo "$(YELLOW)Stopping Server...$(RESET)"
	./quick-start.sh stop

restart: stop start

# --- Testing ---

test: test-backend test-frontend

test-backend:
	@echo "$(YELLOW)Running Backend Tests (Pytest)...$(RESET)"
	$(PYTEST) tests/ -v --tb=short

test-frontend:
	@echo "$(YELLOW)Running Frontend Tests (Jest)...$(RESET)"
	cd frontend && $(NPM) test

# --- Code Quality ---

lint:
	@echo "$(YELLOW)Linting Python code...$(RESET)"
	$(PYTHON) -m flake8 src/ tests/ --count --select=E9,F63,F7,F82 --show-source --statistics
	@echo "$(YELLOW)Linting completed.$(RESET)"

format:
	@echo "$(YELLOW)Formatting Python code (Black)...$(RESET)"
	$(PYTHON) -m black src/ tests/
	@echo "$(YELLOW)Formatting Frontend code (Prettier)...$(RESET)"
	npx prettier --write "frontend/static/js/**/*.js" "frontend/static/css/**/*.css" "frontend/tools/**/*.html"

# --- Maintenance ---

clean:
	@echo "$(YELLOW)Cleaning up...$(RESET)"
	rm -rf __pycache__
	rm -rf .pytest_cache
	rm -rf .coverage
	rm -rf htmlcov
	rm -rf dist
	rm -rf build
	find . -type d -name "__pycache__" -exec rm -rf {} +
	find . -type f -name "*.pyc" -delete
	@echo "$(GREEN)Clean complete.$(RESET)"

build: install test
	@echo "$(GREEN)Build (Install + Test) passed successfully.$(RESET)"