Quick Start

Environment Setup

Ensure you have completed every step of environment setup.

Generate your Package Repository

1. Access the Hello World Template

2. Click Use this template > Create new repository. You must be signed into Github to see this button.

   

3. Name your repository. The name should be [service-name]-startos. For example, NextCloud is nextcloud-startos and Lightning Terminal is lightning-terminal-startos.

4. For the repository description, enter "StartOS package for [Service Name]".

5. Make sure the repository is Public.

6. Click "Create Repository".

Clone your Package Repository

From the command line of your local work machine, run the following commands:

git clone [your-repository-url]

cd [repository-name]

npm i

Build and Install your Package

make

This produces a [service-id].s9pk at the root of your project that can be sideloaded through the StartOS UI.

See Building and Installing for more options and to streamline your development workflow.