Skip to content

Commit

Permalink
Add installation page
Browse files Browse the repository at this point in the history
  • Loading branch information
ddxv committed Nov 16, 2023
1 parent 7fb0ee4 commit a8f1f2d
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 25 deletions.
32 changes: 10 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,19 @@
# Open Attribution

# Druid
Open attribution is a project to help developers control their data without resorting to third party control. Our goal is to give developers back control of their app advertising data.

## Druid: Setup
## True ownership of your mobile app's data

# Kafka
`./bin/kafka-topics.sh --create --topic impressions --bootstrap-server localhost:9092`
`./bin/kafka-topics.sh --create --topic clicks --bootstrap-server localhost:9092`
`./bin/kafka-topics.sh --create --topic events --bootstrap-server localhost:9092`
Paying someone else to hold and manage your app's data takes power away from app creators. Open Attribution is a suite of open source tools so that you can manage your advertising data ownership.

https://druid.apache.org/docs/latest/tutorials/
## Open Source Community

## Druid: User (admin)
Open Attribution is committed to building a community of developers who work together to build a secure ecosystem.

https://druid.apache.org/docs/latest/operations/security-overview
## Ready?

# Superset
Head to [Getting Started](https://ddxv.github.io/app-track/getting_started/installation) to learn more.

## Superset: Setup
### Why do apps NEED attribution?

`pip install superset pydruid`

set `export FLASK_APP=superset`
set `export SUPERSET_CONFIG_PATH=superset/superset_config.py`

`superset db upgrade`
`superset fab create-admin` > Setup your username and password for the superset admin login
`superset init`
`superset run -p 8088 --with-threads --reload`

1. Add database `druid://admin:password1@localhost:8888/druid/v2/sql`
If you want to do in-app advertisements attribution a technical requirement, not a business option. Apps cannot use regular HTTP Urls to connect users, deep links are too limited. Historically MMPs stepped in to help solve this complex problem but by doing so became the arbiters of large amounts of data that some apps may wish to maintain control over. Read more about the [historical background here](https://ddxv.github.io/app-track/about/history).
32 changes: 32 additions & 0 deletions docs/getting_started/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

# Druid

## Druid: Setup

# Kafka

`./bin/kafka-topics.sh --create --topic impressions --bootstrap-server localhost:9092`
`./bin/kafka-topics.sh --create --topic clicks --bootstrap-server localhost:9092`
`./bin/kafka-topics.sh --create --topic events --bootstrap-server localhost:9092`

https://druid.apache.org/docs/latest/tutorials/

## Druid: User (admin)

https://druid.apache.org/docs/latest/operations/security-overview

# Superset

## Superset: Setup

`pip install superset pydruid`

set `export FLASK_APP=superset`
set `export SUPERSET_CONFIG_PATH=superset/superset_config.py`

`superset db upgrade`
`superset fab create-admin` > Setup your username and password for the superset admin login
`superset init`
`superset run -p 8088 --with-threads --reload`

1. Add database `druid://admin:password1@localhost:8888/druid/v2/sql`
20 changes: 17 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
# Open Attribution

Open attribution is a project to help developers control their data without resorting to third party control.
Open attribution is a project to help developers control their data without resorting to third party control. Our goal is to give developers back control of their app advertising data.

## True ownership of your mobile app's data

## Why do apps NEED attribution?
Paying someone else to hold and manage your app's data takes power away from app creators. Open Attribution is a suite of open source tools so that you can manage your advertising data ownership.

It's a technical requirement, not a business option. Apps cannot use regular HTTP Urls to connect users, deep links are too limited. Historically MMPs stepped in to help solve this complex problem but by doing so became the arbiters of large amounts of data that some apps may wish to maintain control over. Read more about [this historical overview here](about/history.md).
## Open Source Community

Open Attribution is committed to building a community of developers who work together to build a secure ecosystem.

## Ready?

Head to [Getting Started](getting_started/installation.md) to learn more.



## FAQ:

### Why do apps NEED attribution?

If you want to do in-app advertisements attribution a technical requirement, not a business option. Apps cannot use regular HTTP Urls to connect users, deep links are too limited. Historically MMPs stepped in to help solve this complex problem but by doing so became the arbiters of large amounts of data that some apps may wish to maintain control over. Read more about the [historical background here](about/history.md).
10 changes: 10 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,15 @@ theme:
name: material
icon:
repo: fontawesome/brands/github
features:
- header.autohide
- content.code.copy
palette:
scheme: slate
primary: black

markdown_extensions:
- attr_list
- md_in_html

repo_url: https://github.com/ddxv/app-track

0 comments on commit a8f1f2d

Please sign in to comment.