Files
smom-dbis-138/orchestration/portal/QUICK_START.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

1.7 KiB

🚀 Quick Start Guide

Prerequisites

  • Node.js >= 18.0.0
  • pnpm >= 8.0.0

Installation

1. Install pnpm (if not already installed)

# Using corepack (recommended)
corepack enable
corepack prepare pnpm@latest --activate

# Or using npm
npm install -g pnpm

2. Install Dependencies

cd orchestration/portal
pnpm install

3. Build Project

pnpm build

4. Start Server

# Development mode (with hot reload)
pnpm dev

# Production mode
pnpm start

Access Portals

Once the server is running:

API Endpoints

All API endpoints are available at /api/*:

  • GET /api/environments - List all environments
  • GET /api/environments/:name - Get environment details
  • POST /api/environments/:name/deploy - Trigger deployment
  • GET /api/environments/:name/status - Get status
  • GET /api/environments/:name/metrics - Get metrics
  • GET /api/environments/:name/alerts - Get alerts
  • GET /api/costs - Get cost data
  • GET /api/deployments - List deployments

Troubleshooting

Port Already in Use

PORT=5001 pnpm start

Build Errors

rm -rf dist node_modules
pnpm install
pnpm build

Type Errors

pnpm run type-check

Next Steps

  1. Configure environments in config/environments.yaml
  2. Set up cloud provider credentials
  3. Deploy infrastructure using Terraform
  4. Start managing deployments through the portal

Ready to go! 🎉