telestion-client-core

Telestion Client Core

npm: @wuespace/telestion-client-core

Essential, core components for the development of Project-Specific Clients (PSCs) with the Telestion Client Ecosystem.

These components are not UI-specific and can be used in any UI framework.

This package is included in PSCs bootstrapped using the Telestion Client CLI by default.

Installation

First, add it as dependency to your project:

pnpm add @wuespace/telestion-client-core
# or
npm install @wuespace/telestion-client-core

Please also check that you install a supported version of react and react-dom.

After installation, check out the provided components:

import { TelestionClient } from '@wuespace/telestion-client-core';

function App() {
	return <TelestionClient />;
}

For a full list of components, hooks and utility parts, check out the reference: https://wuespace.github.io/telestion-client/@wuespace/telestion-client-core/

Package structure

.
├── build (built in build script)
├── src
│   ├── components (components provided or used by the library)
│   │   ├── index.ts
│   │   └── [...]
│   ├── hooks
│   │   ├── abstractions (hooks that provide abstractions of other hooks)
│   │   │   ├── index.ts
│   │   │   └── [...]
│   │   ├── managers (hooks that manage specific properties like Singleton instances)
│   │   │   ├── index.ts
│   │   │   └── [...]
│   │   ├── stores (zustand-Store-Hooks)
│   │   │   ├── index.ts
│   │   │   └── [...]
│   │   └── [...]
│   ├── lib (various utilities provided or used by the library)
│   │   ├── index.ts
│   │   └── [...]
│   └── index.ts
├── types (built in build script, gets assembled to single build/index.d.ts file)
│   ├── index.d.ts
│   └── [...]
├── CHANGELOG.md (DO NOT TOUCH! auto-generated changelog for the package)
├── LICENSE
├── package.json
├── README.md (you're here :P)
└── [...] (configuration files, etc.)

Contributing

If you want to contribute to this package, please take a look at the Telestion Client monorepo that manages this package, among other Telestion Client packages.

Contributors

Thank you to all contributors of this repository:

Made with contributors-img.

About

This is part of Telestion, a project by WüSpace e.V..