Skip to content
This repository has been archived by the owner on Oct 4, 2024. It is now read-only.

tiki-deprecated/publish-sdk-capacitor

Repository files navigation

TIKI SDK (Capacitor Plugin)

All Contributors

The TIKI SDK for Capacitor makes it easy to create monetizable zero-party data assets. Create a digitally signed, immutable audit trail with Title, License, Payable, and Receipt records.

Build Data Reward programs that profit you and your users.

Learn more at 🍍 mytiki.com, or jump right into the 📘 API reference.

Installing

Install the dependency from NPM

npm install @mytiki/tiki-sdk-capacitor
npx cap sync

That's it. And yes, it's really that easy.

iOS only:

Add TikiSdk dependencies in Podfile

source 'https://github.com/tiki/PodspecRepo.git' # Add this

platform :ios, '14.0'

def capacitor_pods
  use_frameworks!
  pod 'Capacitor', :path => '../node_modules/@capacitor/ios'
  pod 'CapacitorCordova', :path => '../node_modules/@capacitor/ios'
end

target 'Plugin' do
  capacitor_pods
  use_frameworks! # Add this
  
  pod 'TikiSdkRelease', '3.0.0', :configurations => 'Release' # Add this
  pod 'TikiSdkDebug', '3.0.0', :configurations => 'Debug' # Add this
  
end

target 'PluginTests' do
  capacitor_pods
end

If Cocoapods can't find TikiSdk automatically, run pod install --repo-update.

Initialization

Note: Before you get started, you will need a Publishing ID. It's free to create one; simply log in to our 🧑‍💻 Developer Console and create a new Project.

import { instance } from '@mytiki/tiki-sdk-capacitor'

instance.initialize('<YOUR USER ID>', '<YOUR PUBLISHING ID>')
        .then((rsp) => console.log(`${rsp.address} initialized`))

NOTE: Currently only iOS and Android are supported, not Web. If you'd like to use TIKI for web see our JS SDK or open a new Issue (it's easy to add).

Contributing

  • Use GitHub Issues to report any bugs you find or to request enhancements.
  • If you'd like to get in touch with our team or other active contributors, pop in our 👾 Discord.
  • Please use conventional commits if you intend to add code to this project.

Project Structure

  • /src: The primary TS interface for the plugin.
  • /android: The native Android implementation.
  • /ios: The native iOS implementation.
  • /example: A simple example project using the plugin

Contributors ✨

Mike Audi
Mike Audi

💻 📖 👀
Ricardo Gonçalves
Ricardo Gonçalves

💻 👀
Jessé Monteiro
Jessé Monteiro

💻
Gabriel Schuler Barros
Gabriel Schuler Barros

💻