From 31778014449851d3f188d70d737bcc05eb7d4d3d Mon Sep 17 00:00:00 2001 From: aitbc Date: Mon, 30 Mar 2026 17:24:41 +0200 Subject: [PATCH] refactor: move setup.sh back to project root directory MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Setup Script Restoration - Complete: ✅ SETUP SCRIPT MOVED: Restored setup.sh to project root directory - setup.sh: Moved from scripts/utils/ back to /opt/aitbc/ (project root) - Reason: Main project setup script belongs in root for easy access - Impact: Improves project setup experience and follows standard conventions ✅ ROOT DIRECTORY ENHANCED: 📁 setup.sh: Main project setup script (9.8KB) 📋 Purpose: Sets up AITBC services on new host with systemd 🔧 Functionality: Complete project initialization and configuration 📍 Location: Project root for maximum accessibility ✅ DOCUMENTATION UPDATED: 📚 Development Guidelines: Added setup.sh to essential root files 📖 Test Documentation: Updated to reference root setup.sh 🎯 Usage Instructions: Added ./setup.sh to test prerequisites 📝 Clear Guidance: Updated script location references ✅ SETUP SCRIPT CONTENTS: 🎯 Main Function: AITBC Local Setup Script 🔧 Features: Sets up AITBC services with systemd 📋 Capabilities: Service configuration, user setup, permissions 🎨 Interface: Colored output with logging functions ⚙️ Error Handling: Comprehensive error checking and reporting ✅ IMPROVED PROJECT STRUCTURE: 📁 Root Directory: Now contains essential setup.sh 📁 scripts/utils/: Contains utility scripts (not main setup) 📖 Documentation: Updated to reflect correct locations 🎯 User Experience: Easier project setup with ./setup.sh ✅ STANDARD PRACTICES: 📍 Root Location: Main setup scripts typically in project root 🔧 Easy Access: Developers expect ./setup.sh in root 📦 Complete Setup: Single script for full project initialization 🎯 First Step: Clear entry point for new developers BENEFITS: ✅ Better UX: Easy to find and run ./setup.sh ✅ Standard Practice: Follows common project conventions ✅ Clear Entry Point: Single script for project setup ✅ Documentation: Updated to reflect correct locations ✅ Accessibility: Setup script in most accessible location RESULT: Successfully moved setup.sh back to project root directory, improving project setup experience and following standard conventions while updating all relevant documentation. --- docs/advanced/05_development/DEVELOPMENT_GUIDELINES.md | 1 + scripts/utils/setup.sh => setup.sh | 0 tests/docs/README.md | 7 +++++-- 3 files changed, 6 insertions(+), 2 deletions(-) rename scripts/utils/setup.sh => setup.sh (100%) diff --git a/docs/advanced/05_development/DEVELOPMENT_GUIDELINES.md b/docs/advanced/05_development/DEVELOPMENT_GUIDELINES.md index f9609461..bf48fe1f 100644 --- a/docs/advanced/05_development/DEVELOPMENT_GUIDELINES.md +++ b/docs/advanced/05_development/DEVELOPMENT_GUIDELINES.md @@ -12,6 +12,7 @@ - `poetry.lock` - Dependency lock file - `pytest.ini` - Test configuration - `scripts/testing/run_all_tests.sh` - Main test runner +- `setup.sh` - Main project setup script ### Development Scripts → `dev/scripts/` ```bash diff --git a/scripts/utils/setup.sh b/setup.sh similarity index 100% rename from scripts/utils/setup.sh rename to setup.sh diff --git a/tests/docs/README.md b/tests/docs/README.md index 9aad6684..f2bb3c66 100644 --- a/tests/docs/README.md +++ b/tests/docs/README.md @@ -49,14 +49,17 @@ scripts/testing/ # Main testing scripts └── test-all-services.sh # Service testing scripts/utils/ # Testing utilities -├── setup.sh # System setup (includes testing) -└── requirements_migrator.py # Dependency management +├── requirements_migrator.py # Dependency management +└── other utility scripts # Various helper scripts ``` ## Prerequisites ### Environment Setup ```bash +# Run main project setup (if not already done) +./setup.sh + # Activate central virtual environment source /opt/aitbc/venv/bin/activate