Kit application template

The Kit application template is a simple way to get started with a new service. It provides a basic structure for a new service and is available from Github: kit-app-template

Quick start

To get started with the Kit application template, run the following commands:

Clone the repository and cd into the directory:

git clone https://github.com/NVIDIA-Omniverse/kit-app-template.git
cd kit-app-template

Create a new service using the wizard:

./repo.sh template new

Follow the prompt instructions:

? Select with arrow keys what you want to create: Application
? Select with arrow keys your desired template: Kit Service
? Enter name of application .kit file [name-spaced, lowercase, alphanumeric]: [set application name]
? Enter application_display_name: [set application display name]
? Enter version:: [set application version]

The application template you have selected requires a setup extension.
Setup Extension -> kit_service_setup
? Enter name of extension [name-spaced, lowercase, alphanumeric]: [set extension name]_setup_extension
? Enter extension_display_name: [set extension display name] Setup Extension
? Enter version: [set extension version]

Build your new application with the following command:

./repo.sh build

A successful build will result in the following message:

BUILD (RELEASE) SUCCEEDED (Took XX.XX seconds)

If there are issues related to build, please see the Usage and Troubleshooting section in the README.md of the repository for additional information.

Initiate the newly created application using:

./repo.sh launch

A successful launch will result in a message similar to the following:

[my_company.my_service_setup_extension] MyExtension startup : Local Docs -  http://localhost:8011/docs

Browse to the URL in the message to view the OpenAPI documentation for the service.