Skip to content
This repository has been archived by the owner on Aug 15, 2023. It is now read-only.

Latest commit

 

History

History
57 lines (42 loc) · 1.25 KB

README.md

File metadata and controls

57 lines (42 loc) · 1.25 KB

Taboule

A table component to properly display TRex data provided by generalized API contract.

Getting Started

Prerequisites:

  • node >= 16
  • yarn >= 3

Always run yarn in the project's root:

yarn

Development

To start developing Taboule just run yarn watch - or yarn taboule watch from the root - and open localhost:3002.

Build

To produce an optimized bundle for distribution you need to run:

# use `NODE_ENV=production yarn taboule build` if you run it from root
NODE_ENV=production yarn build

Usage

To include Taboule in your project you need to include the taboule.js file in build in your html, normally it should be copied in static/js/generated folder:

<html>
  <body>
    <h2>Taboule</h2>
    <div id="main"></div>
  </body>
  <script type="text/javascript" src="/js/generated/taboule.js"></script>
  <script type="text/javascript">
    var baseURL = 'https://youtube.tracking.exposed/api/';

    window.Taboule({
      showInput: showInput,
      node: document.getElementById('main'),
      baseURL: baseURL,
      query: query,
      pageSize: 25,
      initialParams: {
        channelId: 'your-channel-id',
      },
    });
  </script>
</html>