b5d18c1c74
## What Based on some customer feedback that our setup guides were a bit difficult to follow and they just wanted a one page step-by-step. - Adds a straight shooting one-page guide for folks embedding us into an existing application - Moves existing getting started guides that showcased demo applications into a "Tutorials" area This does depend on https://github.com/airbytehq/sonar/pull/1049 being merged, which moves the Applications Token endpoint to the public Sonar API (another request from that customer!)
1.5 KiB
1.5 KiB
products
| products |
|---|
| embedded |
2-Minute Quickstart
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 michel@airbyte.io or teo@airbyte.io 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