Skip to content

QUICK_START.md

Latest commit

 

History

History
116 lines (83 loc) · 2.35 KB

QUICK_START.md

File metadata and controls

116 lines (83 loc) · 2.35 KB
Raw

Quick Start Guide

Get Citadel up and running in 5 minutes.

1. Prerequisites

# Install Node.js 24+
node --version

# Install AWS CDK
npm install -g aws-cdk

# Configure AWS CLI
aws configure

2. Configure

# Copy environment template
cp backend/.env.example backend/.env

# Edit with your details
nano backend/.env

Minimum required in .env:

ENVIRONMENT=dev
CDK_DEFAULT_ACCOUNT=your-account-id
CDK_DEFAULT_REGION=ap-southeast-2
ADMIN_EMAIL=your-email@example.com
ADMIN_PASSWORD=YourSecurePass123!

3. Deploy

# Deploy everything
./deploy.sh

# Or with AWS profile
./deploy.sh --profile my-profile

4. Access

After deployment completes:

  1. Find CloudFront URL in outputs
  2. Navigate to URL
  3. Login with your ADMIN_EMAIL and ADMIN_PASSWORD

Common Commands

# Deploy all stacks
./deploy.sh --all

# Deploy backend only
./deploy.sh --backend-only

# Deploy with profile
./deploy.sh --profile my-aws-profile

# Deploy specific stack
./deploy.sh BackendStack

# Get help
./deploy.sh --help

Troubleshooting

Build fails?

cd frontend && npm install
cd ../backend && npm install

Need to bootstrap CDK?

cdk bootstrap aws://ACCOUNT/REGION

Want to start over?

cd backend
cdk destroy --all

Next Steps

  • Read DEPLOYMENT.md for detailed guide
  • Check backend README for backend-specific info
  • Review CloudFormation outputs for API endpoints
  • Add more users in Team Management

Run the Demo Workflow

Every deployment seeds a runnable Echo Demo Workflow blueprint and a real demo-echo-agent that echoes its input — no configuration needed.

  1. Open Agent Apps and create an app (or pick an existing one)
  2. In the blueprint catalog, choose Echo Demo Workflow → Use in App and select your app — no agent remapping is needed
  3. In the app's Workflows tab, click Publish on the imported "Echo Demo Workflow (Copy)" card
  4. Click Run and watch the live status indicator (Pending → Running → Completed)
  5. Open the Executions tab and click the run to see the per-node timeline and the echoed output

See WORKFLOW_USER_GUIDE.md for the full walkthrough.

Support

  • Check CloudWatch Logs for errors
  • Review CloudFormation events
  • Verify IAM permissions