Frontastic sandboxes

Quick start guide to working with the Frontastic CLI and a Frontastic sandbox.

πŸ‘

Prerequisites

  • Homebrew installed locally
  • Node installed locally (version 14-16)
  • Yarn installed locally (version 1.22+)
  • Access to your company's GitHub customer repository
  • Access to your company's project in the Frontastic studio
  • Your favorite IDE
  1. Clone your GitHub customer repository to your local machine

  2. Open the Frontastic studio and click Developer

  1. Click Sandboxes

  1. Click the blue add icon

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

  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)

πŸ“˜

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

  1. Select a region where you want the sandbox to be hosted

  1. Click Create

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

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

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

🚧

If you're using Windows, you'll need to download the latest package from the Frontastic CLI release page. 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 Frontastic sandbox or a staging server for development? - We're using a sandbox so we'll select Frontastic sandbox
  • Enter the hostname of your Frontastic sandbox - Go to the Frontastic studio and copy the Host from your newly created Frontastic sandbox by clicking the copy icon and paste it into the Frontastic CLI

πŸ‘

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.


Did this page help you?