# Quickstart (/vela-pro/get-started/quickstart)



Once the packages are installed ([Installation](/vela-pro/get-started/setup)), call `enableVelaPro()` and mount a `VelaWorkspace` from Vela's open-source core:

```ts
import { VelaWorkspace } from '@luxalgo/vela/workspace';
import { BinanceProvider } from '@luxalgo/vela/providers/binance';
import { enableVelaPro } from '@luxalgo/vela-pro';

enableVelaPro();

const workspace = new VelaWorkspace('#chart', {
    layout: false,
    symbol: 'BTCUSDT',
    timeframe: '60',
    live: true,
    providers: { binance: () => new BinanceProvider() },
    persist: true,
});
```

Give the target container an explicit height, since `VelaWorkspace` fills the dimensions of the element it mounts into:

```html
<div id="chart" style="height: 100vh"></div>
```

`VelaWorkspace` mounts the full charting shell, and `layout: false` starts with a single chart rather than a multi-chart grid selector. `BinanceProvider` is a public data provider bundled with the core that requires no API key during initial development; replace it with your custom `DataProvider` implementation when connecting your market feed.

Opening the page renders a live candlestick chart with a **Replay** button in the topbar, a right-hand side rail containing Watchlist, Alerts, Order Book, Pine editor, and core tool panels, and **Footprint** and **TPO** styles in the chart style menu.

Setting `persist: true` saves the workspace state (active symbol, timeframe, drawings, indicators, and module preferences) to `localStorage` and restores it on reload. See [Persistence overview](/vela-pro/persistence/overview) for details on what each feature stores and how to connect a server-side storage adapter.

## Initialization order [#initialization-order]

`VelaWorkspace` reads the core's plugin registries during construction, so `enableVelaPro()` must run before `new VelaWorkspace()`. Any workspace constructed prior to `enableVelaPro()` renders without the side rail, Replay controls, or Vela Pro modules.

Each feature installs at most once per page load. Calling `enableVelaPro()` a second time does not reconfigure or remove features that were already installed, and options for already-installed features are ignored. The `watermark` option is the one exception because each call updates the default corner attribution for charts created afterward. Call `enableVelaPro()` once with your full configuration during application startup.

## Data requirements by feature [#data-requirements-by-feature]

Most Vela Pro capabilities operate on standard OHLCV candle data, including TPO charts, bar replay, Pine Script® and the code editor, the Strategy Tester, Watchlist, Alerts, and the workspace layout. Several order-flow and market-depth features read extended provider interfaces or external endpoints:

| Feature                           | Required data interface                                                        | Behavior with an OHLCV-only provider                                                                                                                         |
| --------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Footprint chart type              | `FootprintFeed` ([Footprint data](/vela-pro/data/feeds/footprints))            | Appears in the chart style menu, keeps rendering candles without footprint cells, and logs a console warning.                                                |
| Order-flow indicators             | `FootprintFeed` ([Footprint data](/vela-pro/data/feeds/footprints))            | Excluded from the indicator menu, where the Orderflow tab lists only studies computable from OHLCV bars.                                                     |
| Order Book module                 | `DepthFeed` ([Quotes and market depth](/vela-pro/data/feeds/quotes-and-depth)) | Opens in the side rail and displays "No order book".                                                                                                         |
| LuxAlgo library in indicator menu | Reachable library endpoint ([Indicator menu](/vela-pro/indicators/library))    | Remote library tabs display "The library is unreachable" and log failed network requests, while built-in studies and user scripts continue working normally. |

None of these fallback states indicate an installation failure; connect the corresponding feed interface when your product requires that capability.

## Configuring and disabling features [#configuring-and-disabling-features]

Every built-in Vela Pro feature is enabled by default when you call `enableVelaPro()`. Pass `false` to disable a feature, or pass an options object to customize it:

```ts
import { enableVelaPro } from '@luxalgo/vela-pro';

enableVelaPro({
    footprint: false,
    orderBook: false,
    watchlist: { defaultSymbols: ['BTCUSDT', 'ETHUSDT'] },
    strategyTester: { autoOpen: false },
});
```

This configuration removes Footprint from the chart style menu, omits Order Book from the side rail, seeds the initial watchlist with two symbols, and prevents the Strategy Tester dock from opening automatically when a strategy runs.

| `enableVelaPro` option             | Capability                                               | Standalone enabler          |
| ---------------------------------- | -------------------------------------------------------- | --------------------------- |
| `footprint`                        | Footprint chart type                                     | `enableFootprint`           |
| `tpo`                              | TPO (Market Profile) chart type                          | `enableTpo`                 |
| `orderflowIndicators`              | Order-flow native indicators                             | `enableOrderflowIndicators` |
| `indicatorLibrary`                 | Tabbed indicator menu                                    | `enableIndicatorLibrary`    |
| `indicatorTemplates`               | Saved indicator templates                                | `enableIndicatorTemplates`  |
| `replay`                           | Topbar Replay button and playback control bar            | `enableReplay`              |
| `pineEngine`                       | Pine Script® default scripting engine                    | `enablePineEngine`          |
| `codeEditor`                       | Pine code editor side panel                              | `enableCodeEditor`          |
| `strategyTester`                   | Strategy Tester bottom dock panel                        | `enableStrategyTester`      |
| `sideRail`                         | Right-hand side rail                                     | `enableSideRail`            |
| `bottomDock`                       | Resizable bottom dock                                    | `enableBottomDock`          |
| `symbolSearch`                     | Categorized symbol search dialog                         | `enableSymbolSearch`        |
| `radialWheel`                      | Alt-hold radial drawing-tool wheel                       | `enableRadialWheel`         |
| `drawingMenus`                     | Searchable drawing toolbar menus                         | `enableDrawingMenus`        |
| `symbolDrawings`                   | Per-symbol drawing storage                               | `enableSymbolDrawings`      |
| `richTooltips`                     | Card-style control tooltips                              | `enableRichTooltips`        |
| `alerts`, `watchlist`, `orderBook` | Default domain modules                                   | None                        |
| `plugins`                          | Additional domain or custom modules                      | None                        |
| `watermark`                        | Bottom-left corner attribution mark (`false` by default) | None                        |

`footprint`, `tpo`, and `orderflowIndicators` accept boolean values (`true` or `false`) only. See the [Enablers API reference](/vela-pro/api/enablers) for every feature's options interface.

## Selective feature enablers [#selective-feature-enablers]

Instead of calling `enableVelaPro()`, you can import and invoke individual `enable*` functions when you want a narrow subset of features without the rest of the suite:

```ts
import { VelaWorkspace } from '@luxalgo/vela/workspace';
import { BinanceProvider } from '@luxalgo/vela/providers/binance';
import { enableCodeEditor, enablePineEngine, enableReplay, enableTpo } from '@luxalgo/vela-pro';

enableTpo();
enableReplay();
enablePineEngine();
enableCodeEditor();

const workspace = new VelaWorkspace('#chart', {
    layout: false,
    symbol: 'BTCUSDT',
    providers: { binance: () => new BinanceProvider() },
});
```

Call individual enablers before constructing any workspace. This setup adds the TPO chart style, Replay button, Pine Script® engine, and code editor directly to the core's topbar while omitting the side rail and modules, and preserves the core's default corner attribution mark because `watermark` is configured on `enableVelaPro()`.

## Adding optional modules [#adding-optional-modules]

Trading, Journal, and Calendar are opt-in workspace packages. After installing their tarballs ([Installation](/vela-pro/get-started/setup)), pass their factory results in the `plugins` array (the API refers to modules as plugins):

```ts
import { enableVelaPro } from '@luxalgo/vela-pro';
import { trading } from '@luxalgo/vela-pro-trading';
import { journal } from '@luxalgo/vela-pro-journal';
import { calendar } from '@luxalgo/vela-pro-calendar';

enableVelaPro({ plugins: [trading(), journal(), calendar()] });
```

With these three modules registered, the side rail adds the Order Ticket, Journal, and Calendar panels, the bottom dock adds the Trading panel, and a Buy/Sell ticket backed by a simulated paper trading account renders on the chart. Because the Journal module depends on Trading, passing `journal()` without `trading()` skips Journal installation and logs a console error naming the missing dependency. See [Modules overview](/vela-pro/modules/overview) to connect each module to your backend services.

## Related [#related]

* [Workspace layout](/vela-pro/charts/interface)
* [Data connectivity](/vela-pro/data/overview)
* [React](/vela-pro/get-started/frameworks/react), [Next.js](/vela-pro/get-started/frameworks/nextjs), and [Vue](/vela-pro/get-started/frameworks/vue)
* [Architecture](/vela-pro/get-started/architecture)
