README.md

⚠️ Attention!

This repository is no longer the main development tree for the RocketSound Client and therefore deprecated.
Please use the new combined project repository instead: telestion-project-rocketsound

Telestion Rocketsound PSC

This Telestion PSC (Project-Specific Client) was bootstrapped with the Telestion Client CLI.

Getting started

NOTE: All commands below, unless otherwise specified, should get executed in the cloned project's root folder (that contains the package.json) or a subfolder thereof.

The first step is to install the development dependencies. They are defined in package.json and you can install them with the following command:

npm ci

Running

To build and run the project in development mode, execute:

npm start

Build and deploy

The build command generates a ready-to-deploy web application and native app.

To build the entire project, run:

npm run build

Project structure

The project structure is like the structure created by create-react-app (CRA), plus some special structures:

.
├── public (static files, cf. CRA documentation)
│   ├── index.html
│   ├── favicon.ico
│   └── [...]
├── src
│   ├── components
│   │   ├── app.tsx (the overall PSC React App)
│   │   ├── header.tsx (the header component)
│   │   └── login-page.tsx (the login page)
│   ├── model
│   │   └── sample-user-config.ts (the initial user config)
│   ├── widgets
│   │   ├── sample-widget (a sample widget included in the template)
│   │   │   ├── index.ts (widget meta model, including a unique widget name)
│   │   │   └── widget.tsx (widget component definition)
│   │   └── index.ts (array of widgets)
│   ├── index.css
│   ├── index.tsx
│   └── [...]
├── package.json
├── README.md (you're here :P)
├── telestion.config.js (configuration of the PSC, such as plugins, etc.)
└── tsconfig.json (configuration for TypeScript compilation)

Learn More

To get started with PSC Development, you can take a look at the PSC Developer Manual. It contains many explanations of the most important concepts, practical guides, references, and more.

You can find the latest versions (in PDF format) in the Documentation Repo Releases.

For a full API Reference of all the Telestion Client APIs, check out the documentation of the Telestion Client: https://wuespace.github.io/telestion-client/

To learn React, check out the React documentation.