How to Scaffold an App

Background

See this page for what Scaffold is:

Scaffold

Prerequisites

We currently only support Docker for containerization

1. Install Docker https://docs.docker.com/engine/install/

2. After installation ensure that docker compose is a valid command

Steps to Scaffold an App

1. Run the scaffold app create command in the root of your app directory.

stoobly-agent scaffold app create <APP-NAME>

Recommended for E2E Testing: Include --plugin playwright or --plugin cypress when creating the app scaffold. This sets up Playwright or Cypress-specific configurations and dependencies for running E2E tests.

We recommend running this command from the root directory of a version-controlled code repository.

1. A .stoobly context will be created in the app directory if it does not already exist

   1. Inside the context folder, a docker folder will be created with initial core services