1. Docs
  2. Deployment

Deploy to Shopify Oxygen

Published on Oct 10, 2023, updated 5 months ago

Deploying Your Weaverse Hydrogen Project to Shopify Oxygen

Enhance your e-commerce presence by deploying your Weaverse Hydrogen project to Shopify Oxygen. This guide aligns with the official Oxygen documentation to streamline your deployment process.

Deployment Steps

Install the Hydrogen App

Visit the Shopify Hydrogen App page and install the Hydrogen app in your Shopify store.

Create a GitHub Repository

  • For Existing Local Projects: Commit and push your project to a new GitHub repository.
  • For New Projects: Go to Weaverse Hydrogen template and select the "Use this template" option to create a new repository.

Set Up Your Storefront

Within your Shopify store's Hydrogen app, click the "Create storefront" button to initiate the setup.

Connect to Your Repository

Connect with Weaverse Pilot Repo

  • Select "Set up GitHub continuous deployment now."
  • Choose your Weaverse Hydrogen repository and click "Create."

Configure the Environment

  • Wait for the Hydrogen app to create a pull request.
  • In "Storefront settings," navigate to "Environments and variables."
  • Add the WEAVERSE_PROJECT_ID environment variable, obtainable from Weaverse Studio's "Project Settings" or the project URL. Weaverse Hydrogen env setup

Merge the Pull Request

  • Merge the pull request created by the Hydrogen app to implement the GitHub Action for Oxygen deployment.
  • If you merge before adding the WEAVERSE_PROJECT_ID, trigger a manual rebuild with a code update. (npx shopify hydrogen deploy) Hydrogen pull request Hydrogen GitHub pull request

Publish Your Storefront & Update Weaverse Preview URL

After the GitHub Action completes:

  • Make the storefront public: Click "..." next to the Storefront name, select "Edit environment," and then choose "Publish." hydrogen edit environment Make Hydrogen storefront public
  • Note: Shopify Plus plans can publish up to 25 Storefronts. Other plans are limited to one.

Additional Note: For Shopify Starter or Development plans, alternative deployment methods like Vercel are required, as the Hydrogen app cannot deploy to Oxygen.

Additional Resources

Was this article helpful?