Getting Started
The following page provides a simple guide on how to use your Storefront Hosting solution for the first time, as well as the prerequisites required to utilize its full capabilities.
Prerequisites
- Access to the "Hosting" section in your SCAYLE Panel.
- Access to a Git repository: it must contain an existing Storefront Application codebase or, if the Initialize Git Repository option is selected, must be empty.
Since more complexity and dependencies are involved in migrating an existing Git repository with the Storefront Application codebase to Storefront Hosting, we prepared a dedicated guideline as part of section Migrate Existing Storefronts.
First Time Repository Set Up
If you are using Storefront Hosting for the first time, please use the following step-by-step guide:
1. Connect Repository
To connect the Git repository that hosts the application's source code, navigate to the Overview section and click the Connect Repository button.
Connect the Git repository
Setting up a GitHub or GitLab repository only requires entering the repository path and an access token with the appropriate permissions for cloning and, when necessary, writing.
Connect the Git repository using a listed provider
If the provider isn't listed, the Other Git Repository option allows the connection details to be entered manually. In this case, a username is also required. Many providers accept any value for the username, while some specify a particular one to use, for example, x-token-auth for Bitbucket.
Connect the Git repository using an unlisted provider
Optionally, you may also:
- Set up the empty repository with a preconfigured, ready‑to‑use Storefront Application.
- Configure the environment variables needed to run the Storefront Application.
When initializing an empty GitLab repository in environments where the Developer role is not permitted to push directly, the access token must have Maintainer permissions, or the Fully protected after initial push branch protection setting must be enabled.
When the settings are complete, clicking the Connect button verifies the credentials and initiates the environment bootstrap.
2. Hosting Setup in Progress
SCAYLE Hosting provisions infrastructure in less than 15 minutes, which includes:
- Injecting a Storefront Application source code into your repository,
- Database provisioning,
- SCAYLE-generated DNS and preview domain setup.
Finally, your initial setup is complete.
Successful Repository Setup
In case of any issues during the setup, you will be notified via a notification that your connection failed. Please retry by double-checking the values you entered for your Git repository. If the failed connection continues, contact your SCAYLE Account Manager so that the SCAYLE team can assist you in the setup.
3. First Time Deploying Your Storefront
To deploy your storefront for the first time, simply click on the "Deploy" button:
- Choose a branch or a tag
- Trigger deployment
A detailed explanation of how to deploy your Storefront via SCAYLE Panel can be found in the section Trigger a Deployment.
4. Visit your Storefront Application
Upon the successful first deployment, your Storefront Application is ready to be viewed
- Visit it by clicking on your SCAYLE pre-generated domain.
Else, utilize the power of further customization by defining different configuration options that suit your Storefront the best. Visit Configuration Management to explore the possibilities.
5. Congratulations 🎉
You have easily set up your Storefront Application & already completed your first deployment!
