Getting Started

This guide will walk you through setting up your local environment for the Teleport HQ platform and give you a brief introduction to the functionality of the code.

Step 1: Setup BOS Workspace

First, visit and set up your BOS workspace using the following link:

Set up BOS Workspace

Step 2: Fork and Clone the Repository

1. Fork the viewer repository: Near Everything Viewer
2. After forking, clone the repository to your local machine.

Step 3: Checkout Relevant Branches

1. In the viewer repository, check out the branch named “teleport”:

   git checkout teleport
   

2. Similarly, check out the branch “teleport” on the bos-workspace repository.

Step 4: Run the Applications

Run both the viewer and the workspace. Upon successful setup, navigate to:

Local Teleport Near Widget Home

Upon opening the link, you'll be presented with a dashboard. Verify its appearance with this reference screenshot:

Deep Dive: Understanding the Code

To understand how the Teleport Generator works, let's look at a couple of code snippets.

Teleport Generator