Getting Started on the UI

Introduction

This learning path gives a general walk through the step needed to get started with the kOS UI SDK. It will guide you through starting from an empty project to a functional UI using the kOS Model Framework.

The steps in the learning path below are accompanied by links to a demo project in GitHub that show practical implementations of the key concepts. The GitHub project is broken up into various branches that reflect the high-level steps needed to get started with the kOS UI SDK. Use the GitHub projects and the corresponding diffs to see what has changed moving from one branch to the next as you go through the learning steps to pick up the building blocks of building a kOS Model Framework-based user interface.

Quickstart

Start Here if you are looking to get started with minimal explanation and want to learn by doing.

Quickstart

Learning Path

Topic	GitHub	Diff
Prerequisites	None	None
Set up a React Project Using Create React App	Step 1	None
Configure the kOS SDK	Step 2	diff
Adding kOS Test Utilities - Optional	Step 2	None
Creating Your First kOS Model	Step 3	diff
Using Models in a React Component - Coming Soon	Step 3	None
Registering Your kOS Model	Step 3	None
Adding Data Services	Step 3	None
Configuring a Topic Handler	Step 4	diff
Using Dependent Models	Step 5	diff

Topic

GitHub

Diff

Prerequisites

None

Set up a React Project Using Create React App

Step 1

None

Configure the kOS SDK

Step 2

diff

Adding kOS Test Utilities - Optional