gni commited on
Commit
5881b67
·
1 Parent(s): 1b4a4ab

feat: implement project orchestration via Makefile and update legal metadata

Browse files

- Integrated GNU Make for container lifecycle management and test automation (DX improvement).
- Updated LICENSE attribution to 'Lucian BLETAN'.
- Enhanced README.md with API schema specifications and orchestrated workflow documentation.
- Standardized Docker-Compose invocation patterns via .PHONY targets.

Files changed (3) hide show
  1. LICENSE +1 -1
  2. Makefile +30 -0
  3. README.md +16 -0
LICENSE CHANGED
@@ -1,6 +1,6 @@
1
  MIT License
2
 
3
- Copyright (c) 2026 Redac_Scan Contributors
4
 
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
  of this software and associated documentation files (the "Software"), to deal
 
1
  MIT License
2
 
3
+ Copyright (c) 2026 Lucian BLETAN
4
 
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
  of this software and associated documentation files (the "Software"), to deal
Makefile ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .PHONY: help build up down logs test clean
2
+
3
+ # Default target
4
+ help:
5
+ @echo "🛡️ Redac Management Commands:"
6
+ @echo " make build - Build all Docker containers"
7
+ @echo " make up - Start the project in the background"
8
+ @echo " make down - Stop and remove containers"
9
+ @echo " make logs - Follow the logs"
10
+ @echo " make test - Run the API test suite"
11
+ @echo " make clean - Remove unused Docker images and volumes"
12
+
13
+ build:
14
+ docker compose build
15
+
16
+ up:
17
+ docker compose up -d
18
+
19
+ down:
20
+ docker compose down
21
+
22
+ logs:
23
+ docker compose logs -f
24
+
25
+ test:
26
+ docker compose run --rm api python tests/verify_all.py
27
+
28
+ clean:
29
+ docker system prune -f
30
+ docker volume prune -f
README.md CHANGED
@@ -22,6 +22,16 @@ A lightweight PII (Personally Identifiable Information) moderation MVP designed
22
 
23
  ## 📦 Getting Started (Docker)
24
 
 
 
 
 
 
 
 
 
 
 
25
  ```bash
26
  docker compose up --build
27
  ```
@@ -72,6 +82,12 @@ curl -X POST http://localhost:8000/redact \
72
 
73
  ## 🧪 Quality Assurance
74
 
 
 
 
 
 
 
75
  ```bash
76
  # Run the test suite
77
  docker compose run api python tests/verify_all.py
 
22
 
23
  ## 📦 Getting Started (Docker)
24
 
25
+ ### Quick Start with Makefile
26
+ If you have `make` installed, you can use these shortcuts:
27
+ ```bash
28
+ make build # Build containers
29
+ make up # Start Redac
30
+ make logs # View logs
31
+ make test # Run tests
32
+ ```
33
+
34
+ ### Manual Docker commands
35
  ```bash
36
  docker compose up --build
37
  ```
 
82
 
83
  ## 🧪 Quality Assurance
84
 
85
+ ### Using Makefile
86
+ ```bash
87
+ make test
88
+ ```
89
+
90
+ ### Manual Docker
91
  ```bash
92
  # Run the test suite
93
  docker compose run api python tests/verify_all.py