tickerowl-app-base

TickerOwl App SDK

This contains the base types and interfaces to create apps for TickerOwl.

Building blocks

• The information that is displayed on the device is called Slide.
• An App can take user inputs, do some processing (async) and return slides to be displayed.
• Each Slide has a type and the information to be displayed.

Make your own TickerOwl App

1. Make new directory for your app. mkdir my-app && cd my-app
2. Initiate npm project npm init -y
3. Install & setup typescript npm install -D typescript & npx tsc --init
4. Install tickerowl-app-base package npm install tickerowl-app-base
5. Create src/index.ts file and add the following code:

import { App, AppInfo, AppSlide } from "tickerowl-app-base";

export default class MyApp implements App {
  getInfo(): AppInfo {
    // Add your app info here as per the types defined
  }

  getSlides(): Record<string, AppSlide> {
    // Add your slides here as per the types defined
  }
}

1. Build the app npx tsc
2. Run the app node dist/run.js <path-to-your-app>
3. Publish the npm package npm publish

For more information, refer to TickerOwl.com or reach out to @pramodk73