Creating the Codebase

This guide will help you create the codebase using the pos-cli.

In order to correctly communicate with the platformOS engine and API, your codebase should be organized into a specific directory structure. The root directory of your project should contain the app directory.


Tip


This guide explains how to create your codebase using the pos-cli. Alternatively, you can create your directory structure by Downloading the Codebase of an Instance you created or have access to.

Requirements

You can create the codebase using the pos-cli, so you have to have it installed on your computer. This functionality is available from version 1.0.6, so make sure you update your pos-cli to the latest version.

Steps

Creating the codebase with the pos-cli is a two-step process:

Step 1: Create the directory structure

To create the codebase, enter:


pos-cli init

pos-cli downloads the directory structure in a zip file, and extracts it into the current directory.

Step 2: Explore your directory structure

Once you've downloaded the codebase, locate and explore it – this is how the directories and code of your platformOS Instances should be organized.

To learn more about the required directories and files, check out our detailed description of the platformOS Codebase.

Next steps

Congratulations! You have created the codebase for your Instance using the pos-cli. You can now deploy and sync changes to your Instance.

Questions?

We are always happy to help with any questions you may have.