Skip to Content
Get Started

Get Started

Use this guide to prepare access and quickly start your Visor development setup.

Prerequisite Requirements

Before you start development, you must have access to both accounts below:

For account setup and bootstrapping, contact Xtremax: https://www.visor.global/#contact 

Quick Start From Template

Fork the template

Manually fork the template repository:

Use the Fork button in the top-right area of the GitLab project page.

Fork the template in GitLab

Confirm repository ownership

After forking, confirm that the new repository is under your team or organization namespace and that your development team has the required access.

Clone your fork locally

Use your fork URL and clone it to your local machine.

git clone <your-fork-url> cd <your-fork-folder>

Configure environment variables

Create a .env.local file in the project root and configure:

# DAAS Configuration (Data as a Service - replaces Directus) NEXT_PUBLIC_DAAS_URL=https://visor-daas.dev.xtremax.com NEXT_PUBLIC_DAAS_STATIC_TOKEN=<your-daas-static-token> NEXT_PUBLIC_VISOR_URL=https://visor-v2.dev.xtremax.com NEXT_PUBLIC_TENANT_ID=<your-tenant-id> NEXT_PUBLIC_BUILD_MODE=ssr

The most critical values are NEXT_PUBLIC_DAAS_STATIC_TOKEN and NEXT_PUBLIC_TENANT_ID. Keep these in sync with the values provided during onboarding.

If the Xtremax Visor team already forked and bootstrapped the project for you during onboarding, you can skip the fork and clone steps and continue directly with environment variable validation and project run.

Run the project

npm install npm run dev

Verify local setup

If everything is configured correctly, your Next.js head should be running on http://localhost:3000. Open it in your browser and you should see the homepage rendered from Visor content.

Local Next.js head running successfully

Verify edit mode in Visor

Dev Mode routes the Visor preview to your local Next.js server instead of the live deployment. This lets you see content changes reflected in real time during development.

To confirm the full integration is working, you can verify that Visor Studio can preview your local head in edit mode:

  1. Log in to Visor Studio using the credentials or Active Directory account from your onboarding.
  2. Navigate to the Page Builder module from the left sidebar.
  3. Open the Pages list and select the home page to enter the detail view.
  4. In the top-right area of the editor, toggle on Dev Mode (the </> icon).
  5. Visor will switch the preview iframe to use your local URL (http://localhost:3000). You should see your locally running head rendered inside Visor Studio.

Local head previewed in Visor Studio dev mode

Next

Choose what you want to continue with next:

Last updated on