Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.the-meridian.ai/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through everything you need to do to go from a blank account to a connected app with a live deployment. By the end, you’ll have an organization, an app linked to your Shopify Partner credentials, a GitHub repository connected, and your first deployment running.
1

Create your account

Go to meridian.app/register and fill in your details:
  • First name and last name
  • Email address
  • Password (confirmed twice)
After you submit the form, Meridian sends a verification email to the address you provided. Open that email and click the verification link before trying to log in.
If the verification email doesn’t arrive within a couple of minutes, check your spam folder. You can also request a new verification email from the login page.
Once your email is verified, log in at meridian.app/login with your email and password.
2

Create an organization

Every app in Meridian belongs to an organization. An organization is your workspace — it holds your apps, your team members, and your billing.After you log in for the first time, you’ll be prompted to create your first organization. Give it a name that represents your business or team. The slug field is auto-generated from the name and is used in URLs, but you can customize it.You can also add an optional description and logo.
If you’re an agency managing multiple clients, create a separate organization for each client. Team members and billing are scoped per organization.
Once your organization is created, Meridian sets it as your active workspace. You can switch between organizations at any time from the organization switcher in the sidebar.
3

Create your first app

Inside your organization, navigate to Apps and click Create app. Enter a name for your app — this is the internal label shown in the Meridian dashboard and doesn’t need to match your App Store listing exactly.After the app is created, open its settings and connect your Shopify Partner credentials. You’ll need three values from your Shopify Partners dashboard:
FieldDescription
store_domainYour development store domain (e.g. your-store.myshopify.com)
shopify_api_keyThe API key for your app from the Shopify Partners dashboard
shopify_api_secret_keyThe API secret key for your app
Keep your shopify_api_secret_key private. Never expose it in client-side code or public repositories.
Once connected, Meridian will show the Shopify connection status as Connected. If it shows Connection error, double-check that your API key and secret match what’s shown in the Shopify Partners dashboard.
4

Connect GitHub

Meridian pulls your source code from GitHub to run deployments. From your app’s settings page, click Connect GitHub and authorize the Meridian GitHub App for your account or organization.After authorization, select the repository that contains your app’s source code. Meridian records:
  • git_provider — the version control provider (GitHub)
  • repo_owner — the GitHub account or organization that owns the repository
  • repo_name — the repository name
You need to be an owner or admin of the GitHub repository to install the Meridian GitHub App. If you’re connecting a repository owned by a GitHub organization, you may need an organization admin to approve the installation.
Once connected, Meridian can watch for new commits and trigger automatic deployments when you push to a configured branch.
5

Create an environment

Environments in Meridian map to the different stages of your deployment pipeline. Navigate to Hosting in the sidebar and click Create environment.Choose a type:
  • Production — your live environment, serving real merchant traffic.
  • Staging — a pre-production environment for testing before you go live.
You can create multiple environments per app. Each environment has its own secrets, so credentials don’t bleed between stages.
Start with a staging environment for your first deployment. This lets you verify everything works before you touch production.
6

Trigger your first deployment

With an environment ready, go to Hosting → Deployments and click Deploy. Select the branch you want to deploy — typically main for production or a feature branch for staging.Meridian pulls the latest commit from that branch, builds your app, and deploys it to the environment. You can watch the build logs in real time from the deployment detail page.When the status changes to Deployed, your app is live on that environment.
You can also configure auto-deploy on your app to trigger a deployment automatically whenever you push to a specific branch. Set the auto_deploy_branch in your app settings to enable this.
7

What's next

Your app is deployed. Here are the most common next steps:

Set up your CRM

Track merchant installs, segments, and transaction history.

Build your pricing plans

Define plans, features, and billing events for your app.

Configure automations

Trigger emails and actions based on customer lifecycle events.

Monitor App Store performance

Track your ranking, reviews, and competitor apps.
Last modified on May 5, 2026