Back to Perspective

Examples

examples/README.md

4.4.11.2 KB
Original Source

Examples

The projects in the directory are self-contained Perspective examples. However, they are designed to run within the Perspective source repository tree. This makes it easy for Perspective OSS developers to test changes and validate that our Examples continue to work, but it also means these examples will most not work without properly linking in the Perspective build environment.

In order to run a project in this directory as written:

  1. Install and build Perspective from source.
  2. Run the project with pnpm run start $PROJECT_NAME from the repository root (not the /examples directory).

VirtualServer Examples

These examples demonstrate custom data source implementations using the VirtualServer API, which allows you to create backends that serve data from any source without loading it into Perspective's tables:

Optional

Generally, the changes necessary to make these examples run without the Perspective source repository are minor path or metadata corrections. Your results may vary.