oib/aitbc
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

refactor: move setup.sh back to project root directory

Browse Source 
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.
This commit is contained in:
aitbc
2026-03-30 17:24:41 +02:00
parent f506b66211
commit 3177801444
3 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/advanced/05_development/DEVELOPMENT_GUIDELINES.md
View File

@@ -12,6 +12,7 @@
- `poetry.lock` - Dependency lock file - `poetry.lock` - Dependency lock file
- `pytest.ini` - Test configuration - `pytest.ini` - Test configuration
- `scripts/testing/run_all_tests.sh` - Main test runner - `scripts/testing/run_all_tests.sh` - Main test runner
- `setup.sh` - Main project setup script
### Development Scripts → `dev/scripts/` ### Development Scripts → `dev/scripts/`
```bash ```bash

0
scripts/utils/setup.sh → setup.sh
View File

7
tests/docs/README.md
View File

@@ -49,14 +49,17 @@ scripts/testing/ # Main testing scripts
└── test-all-services.sh # Service testing └── test-all-services.sh # Service testing
scripts/utils/ # Testing utilities 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 ## Prerequisites
### Environment Setup ### Environment Setup
```bash ```bash
# Run main project setup (if not already done)
./setup.sh
# Activate central virtual environment # Activate central virtual environment
source /opt/aitbc/venv/bin/activate source /opt/aitbc/venv/bin/activate