Skip to content
Tutorial

Launch your first app

This tutorial takes you from an empty Team to a running App deployed from your GitHub repository. For how Teams, Apps, and deploys relate, see How synsmarts organizes your apps; the recurring names used across the portal are defined in Customer terminology.

Before you begin

Section titled “Before you begin”

You need:

  • a synsmarts account with access to a Team;
  • permission to purchase an App for that Team;
  • a Team owner or admin role for connecting GitHub and configuring automatic deploys in steps 4 and later;
  • a GitHub repository containing the code you want to deploy;
  • permission to install or update a GitHub App for the repository owner, or an existing synsmarts Deploy installation that already includes the repository;
  • the framework and resource shape you plan to use.

1. Sign in

Section titled “1. Sign in”

Open the synsmarts portal and sign in. If your account belongs to more than one Team, choose the Team that should own the App.

2. Create the App

Section titled “2. Create the App”

From the Team’s App list, select New app.

  1. Enter an App name, or leave it blank and rename the App later.
  2. Select a plan preset or Custom, then review CPU, memory, database storage, workspace storage, and object storage. Choose Monthly or Annual — save 10%, then review the monthly price or prepaid annual total.
  3. Select the framework. A framework card remains unavailable until the selected shape meets its minimum CPU and memory.
  4. Review the preselected database engine and version, or choose another published option. Select any optional services you need.
  5. Select a saved payment method or enter a new card and billing address. The selected card becomes the Team’s default billing card for all its Apps.
  6. Accept the Terms of Service and Privacy Policy.
  7. Select Purchase Plan.

The current Magento and Shopware minimum is 1 CPU and 7 GiB memory. The portal keeps those framework cards unavailable on smaller shapes.

For each field and payment branch, see Create an App.

3. Follow provisioning

Section titled “3. Follow provisioning”

After the purchase is accepted, the portal opens the new App’s Overview page. The provisioning card shows the current setup stage. Wait for the card to say that the App is provisioned before connecting a repository.

If provisioning fails, use Retry when Overview offers it. If no recovery action is available, contact support with the App name or identifier and any visible error ID. Don’t purchase a replacement App to work around the failure — the original purchase and provisioning operation already identify the App that support must recover.

4. Connect the repository

Section titled “4. Connect the repository”
  1. Open the App.
  2. Select Deploys.
  3. In How this app deploys, select Connect a repo.
  4. Select Continue to GitHub.
  5. On GitHub, choose the organization or personal account that owns the repository and grant the synsmarts Deploy App access to the repository.
  6. Back in synsmarts, select the repository and then Connect repo.

Only Team owners and admins can connect a repository. A billing member who purchased the App must ask an owner or admin to complete this step.

If the repository isn’t listed, update the GitHub App installation to grant it access, then return to repository selection. If the Team has more than one active installation, select the installation that owns the repository first.

Connecting the repository returns you to Deploys. It doesn’t start a deploy, choose a branch, or enable automatic deploys.

For the complete repository procedure, see Connect a GitHub repository.

5. Choose the first revision

Section titled “5. Choose the first revision”

In Deploy now, keep Git selected. The branch picker defaults to the repository’s default branch. Select a different branch or tag when needed.

To deploy an exact commit, open Advanced: deploy a specific commit and enter its 7-40 character hexadecimal commit SHA.

6. Start the first deploy

Section titled “6. Start the first deploy”

Select Deploy. The portal opens the deploy’s detail page — you’ll follow the release through build and promotion from here. The accepted request isn’t yet a successful release; watch the status and timeline until the deploy reaches a terminal result.

If the deploy fails, stay with it rather than starting another. Open the failed deploy, record the failed stage and any visible error identifier, correct the reported problem, and then deploy again.

7. Verify the result

Section titled “7. Verify the result”

Return to Overview and open the App URL shown there. Confirm that the expected revision loads and that the App’s primary customer path works. For database-bearing changes, also verify the affected read and write path.

That’s the whole loop: you now have a provisioned App connected to GitHub and successfully deployed on synsmarts, and every later release follows this same deploy-and-verify path.

Next steps

Section titled “Next steps”