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.
Git repository
- You'll need either an existing Git repository containing your Storefront Application's codebase or an empty one if you wish to start from scratch and use our automated repository initialisation.
An access token for Git repository authentication.

Git Repository Setup Helper

Creating an empty repository -> GitHub / GitLab
Creating an access token -> GitHub / GitLab

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

Navigate to the "Overview" section as part of your Hosting sidebar in the SCAYLE Panel.

Click the button "Connect Repository".
Choose one of the predefined Git repository providers.
- In case you are not using either GitHub or GitLab, you can choose a 3rd option, Other Git Repository, which generically supports other Git providers like Bitbucket.
Enter:
- Your Git Repository URL
  - Example: scaylerepository/test
    - GitHub & GiLab options also include predefined domains.
- Your Access Token
- Your Username
  - Only needed in case you choose Other Git Repository as on option.

Choose optional features:
- Initialize Git Repository
  - Use to have a preconfigured and ready-to-use latest available Storefront Application version set up in your repository.
  - Should be checkmarked only if you are connecting to an empty repository.
- Initialize Environment Variables
  - Use to have the required environment variable set up to run your Storefront Application out-of-the-box.

Click the button "Connect".

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.

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!