Skip to main content

Setup

🛠️ Installation​

Install Dependencies​

Run the following command to install all dependencies:

npm install

Install Hosanna Tools Globally​

npm install -g @tantawowa/hosanna-tools

Install Hosanna Compiler (HSC)​

If you are compiling for Roku, Apple TV, Android TV, Samsung TV, iOS, Android, or Web release targets, ensure you have the Hosanna Compiler installed globally. Tantawowa Ltd will provide installation instructions upon registration.

🖥️ Development Workflow​

Editing Code​

  1. Open Visual Studio Code.
  2. Install the Hosanna UI and BrightScript extensions.
  3. Open the hosanna-ui.code-workspace file.

Developer Process​

Before committing changes, follow these steps:

  1. Run the linter:

    npm run lint

  2. Run tests:

    npm test

  3. Commit changes: Use meaningful commit messages.

🌐 Web Development​

Simulator​

Use the web simulator for faster debugging across shared UI, focus, input, AppConfig, and fragment behavior:

  1. Launch the [WEB] task. This runs Vite and Hosanna Tools in watch mode to generate structs and other files.

Platform Targets​

Use the platform-specific launch target or native project when validating a release:

  • Roku: VS Code [ROKU] launch target and device sideloading.
  • Apple TV and iOS: Apple native project and simulator/device runs.
  • Android TV and Android: Android Studio, emulator, and device runs.
  • Samsung TV: Samsung TV package built from the web target.
  • Web: Vite dev server and production web build.

📘 Documentation​

Explore the docs folder for detailed information:

  • Platforms: release-target setup and validation notes.
  • UI and Interaction: views, focus, input, styles, fragments, and controls.
  • Tools: Hosanna Tools, compiler, DevTools, MCP debugger, and diagnostics.
  • Deployment: packaging, versioning, and CI.