- Homebrew installed locally
- Node installed locally (version 14-16)
- Yarn installed locally (version 1.22+) GitHub customer repository studio
- Your favorite IDE
Creating a sandbox
Clone your GitHub customer repository to your local machine
Open the studio and click Developer
- Click Sandboxes
- Click the Add sandboxes button
- Input a Label (must only contain lowercase letters, numbers, and dashes)
- Input the Branch which has the desired backend features you want to work on (it'll default to your
masterbranch if left empty)
The Add public DNS option is automatically selected. You can't disable this.
- Click Create
Your sandbox will then be brought up. This can take up to 10 minutes. Once ready, it'll have the status of
See the using sandboxes in the studio article for more information.
Connecting to the sandbox
- Run the below command to install the latest version of the CLI
If you're using Windows, you'll need to download the latest package from the 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.
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.
You'd also need to generate an SSH 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
You can also run
frontastic init --sandbox <your-sandbox-name> to make the setup quicker.
To install the required node modules for the project to run.
Once you see the dashboard (example below) and everything has been set up successfully, you're ready to start creating your commerce site.