Skip to main content

Getting Started

๐Ÿš€ Prerequisitesโ€‹

Ensure you have the following installed:

  • Node.js: Version 20.5.0 or higher (as specified in [ci.yml])
  • Python: Required for certain tools.
  • Operating System: A *nix-based OS (BSD, macOS, Unix, WSL).
  • Editor: Visual Studio Code (officially supported) or any MS Language Server Protocol (LSP) editor.

โš ๏ธ Note: Windows is not directly supported. Use WSL for compatibility. Refer to the WSL installation guide and the VS Code WSL guide.


๐Ÿ“‚ Folder Structureโ€‹

src/hosanna-list         - List-related sources
src/hosanna-bridge-* - Bridge-related sources
src/hosanna-ui - UI-related sources
src/hosanna-ui-examples - Example code for testing UI components
platforms/roku - Roku-specific sources
assets - Project assets
raw-assets - Raw project assets
support-tools - Tools for debugging, screenshots, etc.

Note: Roku supports folder structures up to seven levels deep.