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, Android-native, or Apple, 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:

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

📘 Documentation​

Explore the docs folder for detailed information:

  • bridge: Hosanna Bridge documentation.
  • list: Hosanna List documentation.
  • ui: Hosanna UI framework documentation.
  • transpiler: Transpiler usage documentation.