Skip to main content

2-Minute Quickstart

Not availableCloud Not availableSelf-Managed CommunityNot availableSelf-Managed EnterpriseAvailableEmbedded Compare

Setup (all apps)

Clone and install dependencies for all apps

git clone https://github.com/airbytehq/embedded-demoapp.git
cd embedded-demoapp
npm install
cd apps/server
cp .env.example .env
# Edit .env with your credentials

Run all apps

# From root directory - starts all apps simultaneously
npm run dev

→ Server & Vanilla JS: http://localhost:3000
→ Next.js: http://localhost:3001
→ React: http://localhost:3002

Run individual apps

# Run only the server
npm run dev --filter=@airbyte-demoapp/server

# Run only React app
npm run dev --filter=@airbyte-demoapp/reactjs

# Run only Next.js app
npm run dev --filter=@airbyte-demoapp/nextjs

Get your credentials

Contact Airbyte: Reach out to [email protected] or [email protected] for Embedded access.

Get your keys: You'll receive your organization ID, client ID, and client secret.

Update config: Add these to your .env file:

# server/.env
SONAR_AIRBYTE_WEBAPP_PASSWORD=your_demo_password
SONAR_AIRBYTE_ALLOWED_ORIGIN=http://localhost:3000
SONAR_AIRBYTE_ORGANIZATION_ID=your_organization_id
SONAR_AIRBYTE_CLIENT_ID=your_client_id
SONAR_AIRBYTE_CLIENT_SECRET=your_client_secret

The sample web app uses basic authentication to protect the webapp. This is fine for testing, but it is recommended to be changed for product use. Set your password in the .env file:

SONAR_WEBAPP_PASSWORD=your_password