Skip to content

Commit c8f14aa

Browse files
committed
chore: update README
1 parent 8e0ee1c commit c8f14aa

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# Clickstream Analytics on AWS
22

3-
An AWS Solution builds clickstream analytic system on AWS with a click-through experience.
4-
This solution automates the data pipeline creation per configurations,
5-
and provides SDKs for web and mobiles apps to help users to collect and ingest client-side data into the data pipeline on AWS.
6-
The solution allows you to further enrich, model, and distribute the event data for business function teams (e.g., marketing, operation) to consume,
7-
and provides a dozen of built-in visualizations (e.g., acquisition, engagement, retention, user demographic)
8-
and explorative reporting templates (e.g., funnel, use path, user explorer),
9-
powering the use cases such as user behavior analytics, marketing analytics, and product analytics.
3+
An end-to-end solution to collect, ingest, analyze, and visualize clickstream data inside your web and mobile applications.
104

11-
## Architecutre of solution
5+
## Solution Overview
6+
7+
This solution collects, ingests, analyzes, and visualizes clickstreams from your websites and mobile applications. Clickstream data is critical for online business analytics use cases, such as user behavior analysis, customer data platform, and marketing analysis. This data derives insights into the patterns of user interactions on a website or application, helping businesses understand user navigation, preferences, and engagement levels to drive product innovation and optimize marketing investments.
8+
9+
With this solution, you can quickly configure and deploy a data pipeline that fits your business and technical needs. It provides purpose-built software development kits (SDKs) that automatically collect common events and easy-to-use APIs to report custom events, enabling you to easily send your customers’ clickstream data to the data pipeline in your AWS account. The solution also offers pre-assembled dashboards that visualize key metrics about user lifecycle, including acquisition, engagement, activity, and retention, and adds visibility into user devices and geographies. You can combine user behavior data with business backend data to create a comprehensive data platform and generate insights that drive business growth.
10+
11+
## Architecture Overview
1212

1313
![architecture diagram](./docs/images/architecture/01-architecture-end-to-end.png)
1414

1515
1. Amazon CloudFront distributes the frontend web UI assets hosted in the Amazon S3 bucket, and the backend APIs hosted with Amazon API Gateway and AWS Lambda.
1616
2. The Amazon Cognito user pool or OpenID Connect (OIDC) is used for authentication.
1717
3. The web UI console uses Amazon DynamoDB to store persistent data.
1818
4. AWS Step Functions, AWS CloudFormation, AWS Lambda, and Amazon EventBridge are used for orchestrating the lifecycle management of data pipelines.
19-
5. The data pipeline is provisioned in the region specified by the system operator. It consists of Application Load Balancer (ALB),
19+
5. The data pipeline is provisioned in the Region specified by the system operator. It consists of Application Load Balancer (ALB),
2020
Amazon ECS, Amazon Managed Streaming for Kafka (Amazon MSK), Amazon Kinesis Data Streams, Amazon S3, Amazon EMR Serverless, Amazon Redshift, and Amazon QuickSight.
2121

22-
See [the doc][doc-arch] for more detail.
22+
For more information, refer to [the doc][doc-arch].
2323

2424
## SDKs
2525

@@ -28,31 +28,31 @@ Clickstream Analytics on AWS provides different client-side SDKs, which can make
2828
- [Android][android-sdk]
2929
- [Swift][swift-sdk]
3030

31-
## How to deploy the solution
31+
## Deployment
3232

33-
### Deploy from one-click CloudFormation templates
33+
### Using AWS CloudFormation template
3434

35-
Follow the [implementation guide][doc-deployment] to deploy the solution with few clicks.
35+
Follow the [implementation guide][doc-deployment] to deploy the solution using AWS CloudFormation template.
3636

37-
### Deploy from source
37+
### Using AWS CDK
3838

39-
#### Prerequisites
39+
#### Preparations
4040

41-
- An AWS account
41+
- Make sure you have an AWS account
4242
- Configure [credential of aws cli][configure-aws-cli]
43-
- Install node.js LTS version 16.18.0 at least
43+
- Install node.js LTS version 16.18.0 or later
4444
- Install Docker Engine
45-
- Install the dependencies of solution via executing command `yarn install --check-files && npx projen`
46-
- Initialize the CDK toolkit stack into AWS environment(only for deploying via [AWS CDK][aws-cdk] first time), run `npx cdk bootstrap`
45+
- Install the dependencies of the solution by executing the command `yarn install --check-files && npx projen`
46+
- Initialize the CDK toolkit stack into AWS environment (only for deploying via [AWS CDK][aws-cdk] for the first time), and run `npx cdk bootstrap`
4747

48-
#### Deploy web console
48+
#### Deploy the web console
4949

5050
```shell
5151
# deploy the web console of the solution
5252
npx cdk deploy cloudfront-s3-control-plane-stack-global --parameters Email=<your email> --require-approval never
5353
```
5454

55-
## How to test
55+
## Test
5656

5757
```shell
5858
yarn test

0 commit comments

Comments
 (0)