Files
smom-dbis-138/orchestration/portal/README.md
defiQUG 1fb7266469 Add Oracle Aggregator and CCIP Integration
- Introduced Aggregator.sol for Chainlink-compatible oracle functionality, including round-based updates and access control.
- Added OracleWithCCIP.sol to extend Aggregator with CCIP cross-chain messaging capabilities.
- Created .gitmodules to include OpenZeppelin contracts as a submodule.
- Developed a comprehensive deployment guide in NEXT_STEPS_COMPLETE_GUIDE.md for Phase 2 and smart contract deployment.
- Implemented Vite configuration for the orchestration portal, supporting both Vue and React frameworks.
- Added server-side logic for the Multi-Cloud Orchestration Portal, including API endpoints for environment management and monitoring.
- Created scripts for resource import and usage validation across non-US regions.
- Added tests for CCIP error handling and integration to ensure robust functionality.
- Included various new files and directories for the orchestration portal and deployment scripts.
2025-12-12 14:57:48 -08:00

95 lines
2.3 KiB
Markdown

# Multi-Cloud Orchestration Portal
## 🚀 Quick Start
### Prerequisites
- Node.js >= 18.0.0
- pnpm >= 8.0.0
### Installation
```bash
# Install pnpm globally (if not already installed)
npm install -g pnpm
# Or using corepack (recommended)
corepack enable
corepack prepare pnpm@latest --activate
# Install dependencies
cd orchestration/portal
pnpm install
```
### Development
```bash
# Run with hot reload
pnpm dev
# Or build and run
pnpm build
pnpm start
```
### Access Portals
- **Main Dashboard**: http://localhost:5000
- **Health Dashboard**: http://localhost:5000/dashboard/health
- **Cost Dashboard**: http://localhost:5000/dashboard/costs
## 📦 Technology Stack
- **TypeScript** - Type-safe JavaScript
- **Express.js** - Web framework
- **EJS** - Template engine
- **better-sqlite3** - SQLite database
- **Chart.js** - Data visualization
## 📁 Project Structure
```
orchestration/portal/
├── src/
│ ├── server.ts # Main Express server
│ ├── config.ts # Configuration management
│ ├── database.ts # Database operations
│ └── types/
│ └── index.ts # TypeScript type definitions
├── templates/ # EJS templates
├── static/ # Static assets
├── dist/ # Compiled JavaScript
├── package.json # Dependencies
└── tsconfig.json # TypeScript configuration
```
## 🔧 Scripts
- `pnpm build` - Compile TypeScript to JavaScript
- `pnpm start` - Run compiled server
- `pnpm dev` - Run in development mode with hot reload
- `pnpm watch` - Watch for changes and rebuild
- `pnpm lint` - Run ESLint
- `pnpm type-check` - Type check without emitting files
## 📚 Documentation
- [TypeScript README](README_TYPESCRIPT.md) - Complete TypeScript documentation
- [Migration Guide](MIGRATION.md) - Python to TypeScript migration details
- [Enhanced Features](README_ENHANCED.md) - Original enhanced features documentation
## 🎯 Features
- ✅ Real-time monitoring and metrics
- ✅ Deployment management
- ✅ Health dashboards
- ✅ Cost tracking
- ✅ Alert management
- ✅ Multi-cloud support
## 🔄 Migration Status
**✅ Complete**: All Python code has been migrated to TypeScript.
See [MIGRATION.md](MIGRATION.md) for details.