# @wuespace/telestion

> Telestion is a framework for building ground station / mission control applications.

Latest version **1.0.0-alpha.4** (published 2024-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wuespace/telestion
pnpm add @wuespace/telestion
yarn add @wuespace/telestion
bun add @wuespace/telestion
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.4 |
| Published | 2024-01-26 |
| First published | 2023-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 12 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | WüSpace e. V. |
| Maintainers | wuespaceadmin, pklaschka, fussel178 |
| Keywords | telestion, ground station, mission control, space, spacecraft, spacecrafts, spaceflight |

## Links

- npm: https://www.npmjs.com/package/@wuespace/telestion
- Repository: https://github.com/wuespace/telestion
- Homepage: https://telestion.wuespace.de/
- Issues: https://github.com/wuespace/telestion/issues
- npm.io page: https://npm.io/package/@wuespace/telestion

## Dependencies (12)

- [zod](https://npm.io/package/zod.md) ^3.22.4
- [clsx](https://npm.io/package/clsx.md) ^2.0.0
- [nats.ws](https://npm.io/package/nats.ws.md) ^1.19.1
- [bootstrap](https://npm.io/package/bootstrap.md) ^5.3.2
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [@dnd-kit/core](https://npm.io/package/@dnd-kit/core.md) ^6.1.0
- [@popperjs/core](https://npm.io/package/@popperjs/core.md) ^2.11.8
- [bootstrap-icons](https://npm.io/package/bootstrap-icons.md) ^1.11.2
- [react-bootstrap](https://npm.io/package/react-bootstrap.md) ^2.9.1
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^6.19.0
- [@dnd-kit/utilities](https://npm.io/package/@dnd-kit/utilities.md) ^3.2.2
- [react-error-boundary](https://npm.io/package/react-error-boundary.md) ^4.0.12

## Recent versions

- 1.0.0-alpha.4 (latest) — 2024-01-26
- 1.0.0-alpha.6 (next) — 2024-12-17
- 1.0.0-alpha.3 — 2023-12-19
- 1.0.0-alpha.2 — 2023-12-15
- 1.0.0-alpha.1 — 2023-12-15
- 1.0.0-alpha.0 — 2023-12-15

## README

# Telestion Frontend Library

[![DOI: 10.5281/zenodo.10407142](https://zenodo.org/badge/DOI/10.5281/zenodo.10407142.svg)](https://doi.org/10.5281/zenodo.10407142)
![npm peer dependency version (scoped)](https://img.shields.io/npm/dependency-version/%40wuespace%2Ftelestion/peer/react)
![GitHub License: MIT](https://img.shields.io/github/license/wuespace/telestion)
![npm (scoped)](https://img.shields.io/npm/v/%40wuespace/telestion)

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

## Installation

```shell
pnpm i @wuespace/telestion
```

## Features

- An easy way to build a Telestion frontend
- Based on [Vite](https://vitejs.dev/) and [React](https://reactjs.org/)
- Using [Bootstrap](https://getbootstrap.com/) 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`

```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`

```typescript
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:

```shell
pnpm dev
```

To build the library, run:

```shell
pnpm build
```

To build the documentation, run:

```shell
pnpm docs
```

## License

[MIT License](./LICENSE)

---
_Source: https://npm.io/package/@wuespace/telestion · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._