1.0.0-alpha.4 • Published 3 months ago

@wuespace/telestion v1.0.0-alpha.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

Telestion Frontend Library

DOI: 10.5281/zenodo.10407142 npm peer dependency version (scoped) GitHub License: MIT npm (scoped)

This library contains all the components and utilities that are used in the Telestion Frontend.

Installation

pnpm i @wuespace/telestion

Features

  • An easy way to build a Telestion frontend
  • Based on Vite and React
  • Using Bootstrap for easy styling
  • one simple initTelestion function to initialize a Telestion frontend for minimal boilerplate
  • handles the connection to the Telestion backend services

Usage

In a Vite project, you can use the library like this:

index.html

<!doctype html>
<html lang="en">
	<head>
		<meta charset="UTF-8" />
		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
		<title>Telestion App</title>
	</head>
	<body>
		<div id="root"></div>
		<script type="module" src="/main.ts"></script>
	</body>
</html>

main.ts

import { initTelestion } from '@wuespace/telestion';

import '@wuespace/telestion/telestion.css';

initTelestion({
	version: '0.1.0'
});

Development

The library itself is located under src/lib and the demo app is located under src/app.

To start the demo app, run:

pnpm dev

To build the library, run:

pnpm build

To build the documentation, run:

pnpm docs

License

MIT License