OneKey implementation

Overview

Implementation repository for OneKey.

Reference implementation of the Minimum Viable Product (MVP) defined here.

The demo website can be visited here publisher-demo

flowchart TB

    Demo("Demo Project")
    style Demo fill:#f5f5f5,stroke:#d2d2d2,stroke-width:2px
    click Demo "https://github.com/OneKey-Network/OneKey-implementation/tree/main/paf-mvp-demo-express" "paf-mvp-demo-express"
    
    Core("Core Javascript")
    click Core "https://github.com/OneKey-Network/OneKey-implementation/tree/main/paf-mvp-core-js" "paf-mvp-core-js"
    
    Frontend("Frontend library & widget")
    click Frontend "https://github.com/OneKey-Network/OneKey-implementation/tree/main/paf-mvp-frontend" "paf-mvp-frontend"
    
    Operator("Operator API")
    click Operator "https://github.com/OneKey-Network/OneKey-implementation/tree/main/paf-mvp-operator-express" "paf-mvp-operator-express"
    
    Client("Operator client")
    click Client "https://github.com/OneKey-Network/OneKey-implementation/tree/main/paf-mvp-client-express" "paf-mvp-client-express"
    
    Demo --> Frontend
    linkStyle 0 stroke:#d2d2d2,stroke-width:1px
    Demo --> Operator
    linkStyle 1 stroke:#d2d2d2,stroke-width:1px
    Demo --> Client
    linkStyle 2 stroke:#d2d2d2,stroke-width:1px
    Demo --> Core
    linkStyle 3 stroke:#d2d2d2,stroke-width:1px
    
    Frontend --> Core
    Client --> Core
    Operator --> Core

Loading

Getting started

Clone the repository with its submodules:

git clone --recurse-submodules https://github.com/OneKey-Network/OneKey-implementation.git

Memo: if you forget the submodules option:

git submodule update --init --recursive

Directories

Sub-project	Description
paf-mvp-demo-express	A set of demo publishers and advertisers hosted on NodeJS and using OneKey
paf-mvp-frontend	The official implementation of a frontend client for OneKey, including Javascript library and reference UI widgets
paf-mvp-client-express	A NodeJS (Express) implementation of the client node
paf-mvp-operator-express	A NodeJS (Express) implementation of the operator API
paf-mvp-core-js	The Javascript fondation (data model, endpoint paths...) used by all other projects
paf-mvp-cmp	A OneKey and TCF compatible CMP widget
paf-mvp-audit	The code to generate and show an audit log viewer

To run a demo project of OneKey, visit paf-mvp-demo-express