Skip to main content

Create an XM Cloud project from a starter template in the XM Cloud Deploy App

Abstract

How to create an XM Cloud project in the XM Cloud Deploy App using existing code or a starter template.

In the XM Cloud Deploy App, you can create projects and environments and set up deployment rules for the environment using a graphical user interface. The XM Cloud App provides starter templates to help you quickly set up an XM Cloud project. You can use the source code in the templates for the initial deployment in the environment you create for the project.

To create a new project, you must have an administrator or owner role in an XM Cloud organization.

When you create a project, you also create an environment and run an initial deployment to the environment.

The following video shows you how to create a Headless SXA site in XM Cloud:

To create a project using a starter template:

  1. Log in to your XM Cloud Deploy App account. If you are an admin in multiple organizations, click the organization you want to create a project for.

  2. On the Home page:

    • If your organization has not created any projects before, click Start from a starter template, and then click Next.

    • If your organization has already created a project, click Create new project, Start from a starter template, and then click Next.

  3. Click the starter template you want to use and click Next.

  4. In the Project name field, enter the name you want for your project, then click Next.

  5. Click the source control provider and click Next.

  6. If you have not previously established a connection with your source control provider, click Create a new GitHub connection and follow your provider's instructions.

    Alternatively, to use an existing provider connection, in the Select an existing GitHub connection drop-down menu, click the connection you want to use, and then click Next.

  7. In the Repository name field, enter a unique name for your new repository, and then click Next.

  8. In the Initial environment details dialog, in the Environment name field, enter the environment name.

  9. In the Production environment drop-down menu, choose whether the environment is a production environment, and in the Trigger deployment on commit to branch drop-down menu, choose whether a commit to the branch triggers a deployment.

  10. Click Create and deploy.

The deployment process then:

  • Creates a new repository in the connected GitHub account.

  • Copies the source code from the selected XM Cloud starter template to the new GitHub repository.

  • Provisions the infrastructure and SaaS tenants to host the Content Management (CM) instance in the environment that you defined.

  • Pulls the source code from the GitHub repository to a hosted XM Cloud build server and builds the solution.

  • Deploys the XM Cloud build artifacts on the provisioned CM instance.

When using this approach to configure an XM Cloud project, you can use the resulting repository to set up a local development environment.