Development Workflow

Last edit: Jul 09, 2019
  • Contributors:
  • pavelloz

A development workflow is the process you follow during development to save time and minimize errors. It includes stages like setup (scaffolding), development, testing, integration, optimization, and deployment.

Setup process

The setup process of developing a site using platformOS includes three main steps:

  1. A Partner creates a new Instance through the Partner Portal. The platformOS engine saves the Instance, which – after authorization – becomes available for developers to deploy and sync to.
  2. Developers create the codebase in a local environment.
  3. The pos-cli deploys or syncs the codebase to the Instance.

Version control

We recommend using a version control system. Internally, we use GitHub to host and collaborate on our git repositories.

You can choose other version control systems, or decide to go without any: all that is required is your codebase and an Instance you can sync/deploy to.

Development Instances

Development Instances are different copies of the same Instance/codebase used for developing, updating, and testing a site without risking the integrity of the live site.

You can set up different types of Instances (staging/production) through the Partner Portal.

Local codebase

You develop your site (write code) in your codebase in your local environment.

The framework for the codebase of the Instance is your codebase organized into the required directory structure. To learn more about the directories and files in your platformOS codebase, see platformOS Components.

Staging Instance

The staging Instance can be used for testing, presenting the changes to the client for approval, QA (Quality Assurance), or UAT (User Acceptance Testing).

Production Instance

The production Instance is the live site available to visitors.

Based on the project’s size, scope, or requirements, stages from the above workflow can be removed, or additional stages can be added. For example, a testing site before staging can be added to separate testing from QA and UAT.

Related topics


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