Skip to content
Uniflow

Quick Start

Get a fully functional Customer Data Platform running on your AWS account in minutes.

Prerequisites

Section titled “Prerequisites”
  • Node.js ≥ 20
  • pnpm ≥ 9
  • AWS CLI configured (aws configure)
  • AWS CDK bootstrapped (npx cdk bootstrap)

1. Install the CLI

Section titled “1. Install the CLI”
Terminal window
npm install -g uniflow

2. Initialize your project

Section titled “2. Initialize your project”

Run the interactive setup wizard to generate your configuration:

Terminal window
uniflow init

This prompts you for:

  • AWS region — where to deploy (e.g. us-east-1)
  • Admin email — for Cognito user pool
  • Retention days — how long to keep raw events in S3
  • Connectors — which destination connectors to enable
  • Stack name — CloudFormation stack name

A uniflow.config.yaml file is created in your project root.

3. Deploy

Section titled “3. Deploy”
Terminal window
uniflow deploy

This runs CDK under the hood to provision all AWS resources: API Gateway, Lambda functions, DynamoDB, Kinesis, S3, and more.

4. Verify

Section titled “4. Verify”
Terminal window
uniflow status

You’ll see:

  • Stack status — CREATE_COMPLETE
  • Ingest endpoint — your API Gateway URL
  • Admin UI URL — CloudFront distribution
  • Write key — for authenticating SDK calls

5. Start tracking

Section titled “5. Start tracking”

Install the JavaScript SDK and send your first event:

import { UnifowClient } from '@uniflow/js';


const client = new UnifowClient({
  writeKey: 'your_write_key',
  host: 'https://your-api-gateway-url.amazonaws.com',
});


client.track({
  event: 'Page Viewed',
  userId: 'user_123',
  properties: { page: '/pricing' },
});

Next steps

Section titled “Next steps”