Skip to content

Commit 10c1f53

Browse files
ril3yclaude
andcommitted
docs: update README version references to 1.1.1, add missing documentation
Also clean up root directory structure: - Merge pytest.ini and vulture.toml into pyproject.toml - Consolidate .env.docker.example and .env.https into .env.example - Move shell scripts (build-docker.sh, docker-run.sh, start_https.sh) to scripts/ - Move DOCKER.md to docs/ - Merge requirements-dev.txt into dev-requirements.txt - Remove misplaced test file from package root - Update all cross-references in README, docs, CI workflow, and scripts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 674b1fd commit 10c1f53

30 files changed

Lines changed: 23854 additions & 1095 deletions

.dockerignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ dev_manager.log
6262
# Environment files (use docker-compose env)
6363
.env
6464
.env.local
65-
.env.https
6665
MakerMatrix/frontend/.env
6766
MakerMatrix/frontend/.env.local
6867

.env.docker.example

Lines changed: 0 additions & 32 deletions
This file was deleted.

.env.example

Lines changed: 52 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,67 @@
22
# Copy this file to .env and fill in your actual values
33
# NEVER commit .env to git!
44

5+
# ── Core Settings ─────────────────────────────────────────────
6+
DEBUG=false
7+
LOG_LEVEL=INFO
8+
9+
# Database
10+
DATABASE_URL=sqlite:///./makermatrix.db
11+
12+
# Security (REQUIRED — change in production!)
13+
JWT_SECRET_KEY=your-secure-secret-key-here-change-this-in-production
14+
JWT_ACCESS_TOKEN_EXPIRE_MINUTES=480
15+
JWT_REFRESH_TOKEN_EXPIRE_DAYS=7
16+
17+
# Server
18+
SERVER_HOST=localhost
19+
20+
# CORS
21+
CORS_ORIGINS=http://localhost:3000,http://localhost:5173,http://localhost:5174,http://127.0.0.1:3000,http://127.0.0.1:5173,http://127.0.0.1:5174,*
22+
23+
# Encryption Key for Credential Storage
24+
MAKERMATRIX_ENCRYPTION_KEY=your_encryption_key_here
25+
526
# MakerMatrix API Key (for testing/automation)
627
# Generate via: POST /api/api-keys/ (requires admin authentication)
728
MAKERMATRIX_API_KEY=
829

9-
# DigiKey API Credentials
10-
DIGIKEY_CLIENT_ID=your_digikey_client_id_here
11-
DIGIKEY_CLIENT_SECRET=your_digikey_client_secret_here
12-
# Set to True for sandbox testing, False for production
13-
DIGIKEY_CLIENT_SANDBOX=True
30+
# ── Supplier API Keys (Optional) ─────────────────────────────
31+
# DigiKey OAuth2
32+
DIGIKEY_CLIENT_ID=
33+
DIGIKEY_CLIENT_SECRET=
34+
# Set to true for sandbox testing, false for production
35+
DIGIKEY_CLIENT_SANDBOX=true
1436

15-
# Encryption Key for Credential Storage
16-
MAKERMATRIX_ENCRYPTION_KEY=your_encryption_key_here
37+
# Mouser
38+
MOUSER_API_KEY=
1739

18-
# Database Settings
19-
DATABASE_URL=sqlite:///./makermatrix.db
40+
# LCSC
41+
LCSC_API_KEY=
2042

21-
# Development Settings
22-
DEBUG=False
23-
LOG_LEVEL=INFO
24-
# Set to false to run dev_manager in HTTP mode (default, no certificates required)
43+
# ── AI Configuration (Optional) ──────────────────────────────
44+
# Ollama (local or Docker host)
45+
OLLAMA_BASE_URL=http://host.docker.internal:11434
46+
47+
# OpenAI
48+
OPENAI_API_KEY=
49+
50+
# Anthropic
51+
ANTHROPIC_API_KEY=
52+
53+
# ── HTTPS (Optional) ─────────────────────────────────────────
2554
# Set to true for HTTPS mode (requires certs/ directory with valid SSL certificates)
2655
HTTPS_ENABLED=false
56+
SSL_CERT_PATH=certs/cert.pem
57+
SSL_KEY_PATH=certs/key.pem
58+
HTTPS_PORT=8443
2759

28-
# Security Settings
29-
JWT_SECRET_KEY=your-secure-secret-key-here-change-this-in-production
30-
JWT_ACCESS_TOKEN_EXPIRE_MINUTES=480
31-
JWT_REFRESH_TOKEN_EXPIRE_DAYS=7
60+
# HTTP
61+
HTTP_PORT=8080
62+
HTTP_REDIRECT_TO_HTTPS=true
3263

33-
# Server Configuration
34-
SERVER_HOST=localhost
64+
# CORS Origins for HTTPS (uncomment and adjust if using HTTPS)
65+
# CORS_ORIGINS=https://localhost:8443,https://127.0.0.1:8443,http://localhost:8080
3566

36-
# CORS Configuration
37-
CORS_ORIGINS=http://localhost:3000,http://localhost:5173,http://localhost:5174,http://127.0.0.1:3000,http://127.0.0.1:5173,http://127.0.0.1:5174,*
67+
# DigiKey OAuth Callback for HTTPS (uncomment if using HTTPS)
68+
# DIGIKEY_OAUTH_CALLBACK=https://localhost:8443/digikey_callback

.env.https

Lines changed: 0 additions & 15 deletions
This file was deleted.

.github/workflows/backend-quality.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ on:
66
paths:
77
- 'MakerMatrix/**/*.py'
88
- 'tests/**/*.py'
9-
- 'vulture.toml'
9+
- 'pyproject.toml'
1010
- '.github/workflows/backend-quality.yml'
1111
- 'requirements.txt'
1212
pull_request:
1313
branches: [ main, develop ]
1414
paths:
1515
- 'MakerMatrix/**/*.py'
1616
- 'tests/**/*.py'
17-
- 'vulture.toml'
17+
- 'pyproject.toml'
1818
- '.github/workflows/backend-quality.yml'
1919
- 'requirements.txt'
2020
workflow_dispatch:
@@ -80,16 +80,16 @@ jobs:
8080
- name: Run Vulture dead code analysis
8181
run: |
8282
source venv_test/bin/activate
83-
vulture MakerMatrix/ --config vulture.toml --sort-by-size > vulture_report.txt || true
83+
vulture MakerMatrix/ --config pyproject.toml --sort-by-size > vulture_report.txt || true
8484
cat vulture_report.txt
8585
8686
- name: Check for critical dead code
8787
run: |
8888
source venv_test/bin/activate
8989
# Fail if vulture finds high-confidence (>95%) unused code outside of tests
90-
if vulture MakerMatrix/ --config vulture.toml --min-confidence 95 --exclude MakerMatrix/tests/ | grep -q "unused"; then
90+
if vulture MakerMatrix/ --config pyproject.toml --min-confidence 95 --exclude MakerMatrix/tests/ | grep -q "unused"; then
9191
echo "❌ High-confidence dead code found!"
92-
vulture MakerMatrix/ --config vulture.toml --min-confidence 95 --exclude MakerMatrix/tests/
92+
vulture MakerMatrix/ --config pyproject.toml --min-confidence 95 --exclude MakerMatrix/tests/
9393
exit 1
9494
else
9595
echo "✅ No critical dead code found"

.gitignore

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
1-
# Documentation files (except root README.md and CLAUDE.md)
2-
*.md
3-
**/*.md
4-
!/README.md
5-
!/CLAUDE.md
6-
71
# Claude Code configuration (user-specific)
82
.claude/
3+
CLAUDE.md
94

105
# Byte-compiled / optimized / DLL files
116
__pycache__/
@@ -266,3 +261,19 @@ MakerMatrix/backups/
266261
*.zip
267262
.env
268263
venv_ci_test/
264+
265+
# Debug and test scripts (not part of the test suite)
266+
scripts/debug_*
267+
scripts/test_*
268+
scripts/verify_*
269+
test_output.txt
270+
271+
# Security certificates and keystores
272+
*.pfx
273+
274+
# Data and storage directories (generated at runtime)
275+
data/
276+
secure_storage/
277+
278+
# Windows artifacts
279+
nul

CLAUDE.md

Lines changed: 0 additions & 148 deletions
This file was deleted.

0 commit comments

Comments
 (0)