Grid Logo
X (Twitter)
Deploy Now
Back to Home
Back to Build & Deploy

Deploy from GitHub Repository

This guide walks you through the process of deploying an application from a GitHub repository to Grid.

1
Step 1: Select a Cloud Provider

At the top of the "Deploy Application" screen:

Choose your target cloud environment:

Cloud Provider Selection

This determines where your application will be deployed once built and configured.

📢 Important Payment Information

Each cloud provider implements a unique payment methodology. Akash uses a per-second billing model, while Flux follows a prepaid approach. For comprehensive details on payment requirements and processes, please refer to the Payment Information section.

2
Step 2: Select a GitHub Repository and Source Branch

Before deploying, you must install the Grid GitHub App to grant access to your repositories.

GitHub Repository Selection Interface

In the "Deploy Application" screen, select Git repository as your component source.

Click the Install GitHub App button if you haven't already.

Once installed, you will get redirect to the Grid github app

  • Select your GitHub username or organization.
  • Choose the repository you want to deploy from.
  • Pick the branch (e.g., main) to build your application from.

⚠️ Note

If your desired repository is not listed, go to Account Settings(Github) in the top-right corner and update the permissions of your GitHub App installation.

3
Step 3: Trigger GitHub Actions Workflow

Configure your repository settings and resources:

GitHub Workflow Configuration Interface

After configuring your repository settings and resources, click the Run Workflow button to trigger the GitHub Actions workflow.

Grid will:

  • Automatically push a grid-ci.yml file into your GitHub repository.
  • Trigger the corresponding GitHub Actions workflow for your application.
  • Configure the deployment with the specified resources (CPU, RAM, SSD).

4
Step 4: Payments

Before your deployment goes live, you'll need to handle payments based on your selected cloud provider:

Akash LogoAkash: Per-Second Billing

With Akash, you'll be charged on a per-second basis. Credits are continuously deducted from your account based on resource usage.

  • Pay only for what you use
  • No upfront commitment
  • Unused credits are refundable if deployment is cancelled

Flux LogoFlux: Prepaid Model

With Flux, you'll pay upfront for the total cost of resources for a specified duration (minimum 1 week).

  • Clear upfront costs
  • Duration-based pricing
  • Simplified billing process

For more detailed information about payment options, visit the Payments documentation.