Documentation

Sandboxes

Information icon

Prerequisites

  • Homebrew installed locally
  • Node installed locally (version 14.x)
  • Yarn installed locally (version 1.22+) GitHub customer repository studio
  • Your favorite IDE

Creating a sandbox

  1. Clone your GitHub customer repository to your local machine

  2. Open the studio and click Developer

ce76ea7 Click developer on the dashboard

  1. Click Sandboxes

17f6a69 Click sandboxes in the developer area

  1. Click the Add sandboxes button

9de43fe Click add sandbox button

  1. Input a Label (must only contain lowercase letters, numbers, and dashes)

80b63df Input a label

  1. Input the Branch which has the desired backend features you want to work on (it'll default to your master branch if left empty)

3b35b4f Add a branch if you want

Information icon

The Add public DNS option is automatically selected. You can't disable this.

  1. Click Create

a9052cd Click the create button to make the sandbox

Your sandbox will then be brought up. This can take up to 10 minutes. Once ready, it'll have the status of Running.

46f1fde New sandbox

See the using sandboxes in the studio article for more information.

Connecting to the sandbox

  1. Run the below command to install the latest version of the CLI
brew tap frontasticgmbh/tap && brew install frontastic-cli
Clipboard icon
Warning icon

If you're using Windows, you'll need to download the latest package from the CLI release pageExternal link icon. Once downloaded, you'll need to extract the zip folder and move the frontastic.exe file and frontastic-cli-dependencies folder to the root of your repository.

  1. Run frontastic init
    You'll be asked some questions to set up your configuration. To get started quickly, you can use the answers below:
  • Which project do you want to work on? – this will only appear if you have more than 1 project in your GitHub customer repository
  • Are you using a sandbox or a staging server for development? - We're using a sandbox so we'll select sandbox.
Information icon

You'd also need to generate an SSHExternal link icon key while using a sandbox for development.

  • Enter the hostname of your sandbox - Go to the studio and copy the Host from your newly created sandbox by clicking the copy icon and paste it into the CLI

ffab367 Copy host

Information icon

You can also run frontastic init --sandbox <your-sandbox-name> to make the setup quicker.

  1. Run frontastic install
    To install the required node modules for the project to run.

  2. Run frontastic run
    Once you see the dashboard (example below) and everything has been set up successfully, you're ready to start creating your commerce site.

5a7d366 Frontastic CLI dashboard new