Skip to content

nrkno/sofie-prompter-editor

Repository files navigation

Sofie Prompter Editor

This is the Sofie Prompter Editor application of the Sofie TV Automation System, allowing WYSIWYG editing nad realtime control of the Sofie prompter.

General Sofie System Information


Developer Information

Note: This monorepo uses Yarn and Lerna, so most commands can be run on the root folder (no need to cd into each package).

File Structure

This is a monorepo, all packages resides in shared/packages and apps/.

Initializing

# Set up monorepo and install all dependencies
yarn

# Initial build
yarn build

# Spin up dev server & watch for changes
yarn dev

Now you should be good to go.

Storage

Some application settings will be persisted by the Backend application. These will be stored in the path indicated by environment variable STORAGE_DIR, or inside user's home directory, inside a directory called .sofie-prompter-editor, if the environment variable isn't set.

Before Committing Code

Before any code is committed, run these:

# Build all packages
yarn build

# Lint all packages
yarn lint

# Run all unit tests
yarn test

The NRK logo is a registered trademark of Norsk rikskringkasting AS. The license does not grant any right to use, in any way, any trademarks, service marks or logos of Norsk rikskringkasting AS.