egg/Task_Reporter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add deployment and project documentation with unified env config

Browse Source 
- Add DEPLOYMENT.md for 1Panel deployment guide with troubleshooting
- Add README.md with project architecture and quick start guide
- Update .gitignore to exclude development docs (openspec/, CLAUDE.md, etc.)
- Unify port configuration via .env (BACKEND_PORT, FRONTEND_PORT, MINIO_API_PORT, MINIO_CONSOLE_PORT)
- Update start-dev.sh and check-env.sh to read ports from .env

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
egg
2025-12-08 13:08:02 +08:00
parent 44822a561a
commit 722f570766
6 changed files with 779 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
check-env.sh
View File

@@ -17,6 +17,19 @@ NC='\033[0m' # No Color
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$SCRIPT_DIR"
# Load port configuration from .env file
if [[ -f "$PROJECT_ROOT/.env" ]]; then
BACKEND_PORT="${BACKEND_PORT:-$(grep -E '^BACKEND_PORT=' "$PROJECT_ROOT/.env" 2>/dev/null | cut -d'=' -f2 || echo '8000')}"
FRONTEND_PORT="${FRONTEND_PORT:-$(grep -E '^FRONTEND_PORT=' "$PROJECT_ROOT/.env" 2>/dev/null | cut -d'=' -f2 || echo '3000')}"
MINIO_API_PORT="${MINIO_API_PORT:-$(grep -E '^MINIO_API_PORT=' "$PROJECT_ROOT/.env" 2>/dev/null | cut -d'=' -f2 || echo '9000')}"
MINIO_CONSOLE_PORT="${MINIO_CONSOLE_PORT:-$(grep -E '^MINIO_CONSOLE_PORT=' "$PROJECT_ROOT/.env" 2>/dev/null | cut -d'=' -f2 || echo '9001')}"
else
BACKEND_PORT="${BACKEND_PORT:-8000}"
FRONTEND_PORT="${FRONTEND_PORT:-3000}"
MINIO_API_PORT="${MINIO_API_PORT:-9000}"
MINIO_CONSOLE_PORT="${MINIO_CONSOLE_PORT:-9001}"
fi
# Track overall status
ERRORS=0
WARNINGS=0
@@ -60,7 +73,7 @@ show_help() {
echo " - Docker availability"
echo " - Virtual environment (venv/)"
echo " - Environment file (.env)"
echo " - Port availability (8000, 3000, 9000, 9001)"
echo " - Port availability (reads from .env: BACKEND_PORT, FRONTEND_PORT, MINIO_API_PORT, MINIO_CONSOLE_PORT)"
}
# Parse arguments
@@ -235,10 +248,10 @@ check_port() {
fi
}
check_port 8000 "Backend API"
check_port 3000 "Frontend Dev"
check_port 9000 "MinIO S3"
check_port 9001 "MinIO Console"
check_port "$BACKEND_PORT" "Backend API"
check_port "$FRONTEND_PORT" "Frontend Dev"
check_port "$MINIO_API_PORT" "MinIO S3"
check_port "$MINIO_CONSOLE_PORT" "MinIO Console"
# ============================================================================
# Summary