Zonké Docs

Preview Environments

Local preview environments are shared environments designed to help you rapidly prototype your frontend and share with your team. The application code is built on your local machine and is deployed to a public URL for easy access.

Install the CLI

The Zonké CLI is a command-line tool that helps you interact with Zonké services. Install the CLI with the command:

npm install -g @zonke-cloud/cli

Public Preview Environment

The public preview environment is available to all Zonké users. Application code is deployed on Zonké infrastructure and the application can be accessed via a <your-application>.zonke.app endpoint.

Initial Setup

To set up your local development environment for Zonké, follow these steps:

  1. Navigate to your frontend application's directory.
cd /path/to/frontend
  1. Get your Zonké API access key and token from the dashboard (see api-access-tokens page).
  2. Run the command to create a new preview environment and answer the prompts. Enter zonke.app for the AWS hosted zone.
zonke init
  1. Build your application.
  2. Deploy your application to the preview environment.
zonke deploy
  1. Access your application at the specified endpoint.

Self-hosted Preview Environments

The public preview environment has a limit of 100MB per user. If you need more space, you can set up a self-hosted preview environment. The self-hosted preview environment is hosted on your infrastructure and can be accessed via a custom domain.

Pre-requisites

To set up a self-hosted preview environment:

  1. Connect your AWS account to Zonké and create an IAM role with appropriate permissions.
  2. Create a public AWS hosted zone for your domain (see this guide).

Creating a Self-hosted Preview Environment

To create a self-hosted preview environment, follow these steps:

  1. Navigate to the dashboard.
  2. Select the organization you would like to create the preview environment for.
  3. Click the new application icon.
New Preview Application
  1. Select the Local Preview option in the Preview tab.
  2. Fill out the necessary fields and click the Create button to finalize the setup.
New Preview Application Form

You can use the self-hosted preview environment the same way you use the public preview environment; the only difference is the hosted zone you enter during the setup.

SDK Access

The Zonké SDK is a TypeScript library that helps you interact with Zonké services. Install with the command:

npm install @zonke-cloud/sdk

The SDK source is available on GitHub at zonke-inc/sdk-ts.