Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.34 KB

README.md

File metadata and controls

46 lines (33 loc) · 2.34 KB

Vertex Dev Dashboard

The Vertex Developer Dashboard is an application designed for managing and viewing the Scenes, Files, and the Parts Library associated to your platform account.

This dashboard is intended to be a lightweight option for managing this data, and as such, does not provide all of the functionality available through Vertex Connect. What this dashboard does provide is an easy way to manage, track, and visually inspect the data being brought into the Vertex Platform through a GUI. The tools provided for performing these interactions are split into focused areas. For more information on getting started with the Vertex Developer Dashboard, see the Getting Started guide.

For our multi-tenant account, the dashboard can be found at https://dashboard.developer.vertexvis.com/. Private deployments of the Vertex Platform will also include a custom deployment of this dashboard accessible at a URL generated as part of the initial deployment. Once this initial deployment has completed, the URL generated will be discoverable from Route 53 in AWS, and will contain the dev-dashboard prefix. This dashboard will be pre-configured to work against your private deployment.

Run locally in Docker

  1. Copy .env.local.template to .env.local and optionally edit values
  2. Run docker-compose --file ./docker-compose.yml up to start the app locally
  3. Browse to http://localhost:3000

If you pull down changes, you'll need to run docker-compose --file ./docker-compose.yml build to build them and then docker-compose --file ./docker-compose.yml up again.

Local development

  1. Copy .env.local.template to .env.local and optionally edit values
  2. Install dependencies, yarn install
  3. Run yarn dev to start the local development server
  4. Browse to http://localhost:3000

Project organization

public/       // Static assets
src/
  components/ // Components used in pages
  lib/        // Shared libraries and utilities
  pages/      // Pages served by NextJS
    api/      // API endpoints served by NextJS

Deployment

A few options for deployment,