docs: reorganize project structure and update root README

Project Organization:
- Moved configuration files to project-config/ directory
- Moved documentation files to documentation/ directory
- Moved security reports to security/ directory
- Moved backup files to backup-config/ directory
- Created PROJECT_ORGANIZATION_SUMMARY.md documenting changes
- Updated all script references to new file locations

Root README Simplification:
- Replaced 715-line detailed README with 95-line structure guide
This commit is contained in:
aitbc
2026-04-02 23:17:02 +02:00
parent 08f3253e4e
commit 7035f09a8c
21 changed files with 3326 additions and 693 deletions

335
project-config/.gitignore vendored Normal file
View File

@@ -0,0 +1,335 @@
# AITBC Monorepo ignore rules
# Updated: 2026-03-18 - Security fixes for hardcoded passwords
# Development files organized into dev/ subdirectories
# ===================
# Python
# ===================
__pycache__/
*.pyc
*.pyo
*.pyd
*.so
.venv/
*/.venv/
venv/
env/
*.egg-info/
*.egg
.eggs/
pip-wheel-metadata/
.pytest_cache/
.coverage
htmlcov/
.tox/
.mypy_cache/
.ruff_cache/
# ===================
# Environment Files (SECRETS - NEVER COMMIT)
# ===================
*.env
.env.*
!.env.example
.env.local
.env.*.local
# ===================
# Database & Data
# ===================
*.db
*.sqlite
*.sqlite3
*.db-wal
*.db-shm
data/
apps/blockchain-node/data/
# ===================
# Runtime Directories (System Standard)
# ===================
/var/lib/aitbc/
/etc/aitbc/
/var/log/aitbc/
# ===================
# Logs & Runtime
# ===================
*.log
logs/
*.pid
*.seed
# ===================
# Secrets & Credentials
# ===================
*.pem
*.key
*.crt
*.p12
secrets/
credentials/
.secrets
.gitea_token.sh
keystore/
# ===================
# IDE & Editor
# ===================
.vscode/
.idea/
*.swp
*.swo
*~
# ===================
# OS Files
# ===================
.DS_Store
.DS_Store?
._*
Thumbs.db
ehthumbs.db
Desktop.ini
# ===================
# Build & Compiled
# ===================
build/
dist/
target/
*.o
*.a
*.lib
*.dll
*.dylib
# ===================
# Secrets & Credentials (CRITICAL SECURITY)
# ===================
# ===================
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Password files (NEVER commit these)
*.password
*.pass
.password.*
keystore/.password
keystore/.password.*
# Private keys and sensitive files
*_private_key.txt
*_private_key.json
private_key.*
*.private
# ===================
# Backup Files (organized)
# ===================
backup/**/*.tmp
backup/**/*.temp
backup/**/.DS_Store
backup/updates/*.log
# Large backup files (exceed GitHub size limits)
backup/updates/*.tar.gz
backup/updates/*.zip
backup/updates/*.tar.bz2
# Application backup archives
backup/explorer_backup_*.tar.gz
backup/*_backup_*.tar.gz
backup/*_backup_*.zip
# Backup documentation and indexes
backup/BACKUP_INDEX.md
backup/*.md
backup/README.md
# ===================
# Temporary Files
# ===================
tmp/
temp/
*.tmp
*.temp
*.bak
*.backup
# ===================
# Windsurf IDE
# ===================
.snapshots/
# ===================
# Wallet Files (contain private keys)
# ===================
# Specific wallet and private key JSON files (contain private keys)
# ===================
# Project Specific
# ===================
# Coordinator database
apps/coordinator-api/src/*.db
# Blockchain node data
apps/blockchain-node/data/
# Explorer build artifacts
apps/explorer-web/dist/
# Solidity build artifacts
packages/solidity/aitbc-token/typechain-types/
packages/solidity/aitbc-token/artifacts/
packages/solidity/aitbc-token/cache/
# Local test fixtures and E2E testing
tests/e2e/fixtures/home/**/.aitbc/cache/
tests/e2e/fixtures/home/**/.aitbc/logs/
tests/e2e/fixtures/home/**/.aitbc/tmp/
tests/e2e/fixtures/home/**/.aitbc/*.log
tests/e2e/fixtures/home/**/.aitbc/*.pid
tests/e2e/fixtures/home/**/.aitbc/*.sock
# Keep fixture structure but exclude generated content
!tests/e2e/fixtures/home/
!tests/e2e/fixtures/home/**/
!tests/e2e/fixtures/home/**/.aitbc/
!tests/e2e/fixtures/home/**/.aitbc/wallets/
!tests/e2e/fixtures/home/**/.aitbc/config/
# Local test data
tests/fixtures/generated/
# GPU miner local configs
scripts/gpu/*.local.py
# Deployment secrets (CRITICAL SECURITY)
scripts/deploy/*.secret.*
infra/nginx/*.local.conf
# ===================
# Documentation
# ===================
# Infrastructure docs (contains sensitive network info)
docs/infrastructure.md
# Workflow files (personal, change frequently)
docs/1_project/3_currenttask.md
docs/1_project/4_currentissue.md
# ===================
# Website (local deployment details)
# ===================
website/README.md
website/aitbc-proxy.conf
# ===================
# Local Config & Secrets
# ===================
.aitbc.yaml
apps/coordinator-api/.env
# ===================
# Deploy Scripts (hardcoded local paths & IPs)
# ===================
scripts/deploy/*
!scripts/deploy/*.example
scripts/gpu/*
!scripts/gpu/*.example
scripts/service/*
# ===================
# Infra Configs (production IPs & secrets)
# ===================
infra/nginx/nginx-aitbc*.conf
infra/helm/values/prod/
infra/helm/values/prod.yaml
# ===================
# Node.js
# ===================
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Build artifacts
build/
dist/
target/
# System files
*.pid
*.seed
*.pid.lock
# Coverage reports
htmlcov/
.coverage
.coverage.*
coverage.xml
*.cover
.hypothesis/
.pytest_cache/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# Environments
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# ===================
# AITBC specific (CRITICAL SECURITY)
# ===================
data/
logs/
*.db
*.sqlite
wallet*.json
certificates/
# Guardian contract databases (contain spending limits)
guardian_contracts/
*.guardian.db
# Multi-chain wallet data
.wallets/
.wallets/*
# Agent protocol data
.agent_data/
.agent_data/*
# Operational and setup files
results/
tools/
data/
*.db
*.log
production/data/
production/logs/
config/
*.env
api_keys.txt
*.yaml
!*.example
logs/
production/logs/
*.log
*.log.*
production/data/
production/logs/
dev/cache/logs/
dev/test-nodes/*/data/
backups/*/config/
backups/*/logs/