Appearance

  2. Boilerplates

Boilerplates ​

We provide boilerplates for various frameworks to help you get started quickly with Ogma. These boilerplates are designed to for you to set up Ogma in your projects with minimal configuration and start focusing on the visualization aspects.

Scaffold with npm create ​

The easiest way to use any of these templates is through the official project creator. Run the command below and follow the interactive prompts to select a template and enter your API key:

sh
npm create @linkurious/ogma my-app
sh
yarn create @linkurious/ogma my-app
sh
pnpm create @linkurious/ogma my-app

You can also pass a template name directly to skip the prompt:

sh
npm create @linkurious/ogma my-app -- --template vite

Available template names: vite, webpack, rollup, typescript, node, parcel.

Typescript ​

Raw Typescript boilerplate for Ogma integration. This boilerplate provides a basic setup for using Ogma in a TypeScript project, allowing you to leverage type safety and modern JavaScript features.

Vite ​

Most popular build system for modern web applications. This boilerplate provides a ready-to-use setup for Ogma with Vite, allowing you to leverage its fast development server and optimized builds.

Rollup ​

Rollup is a module bundler for JavaScript. This boilerplate provides a basic setup for integrating Ogma with Rollup, enabling you to bundle your application efficiently.

Webpack ​

Although a legacy build system, Webpack is still widely used. This boilerplate provides a configuration for integrating Ogma with Webpack, allowing you to take advantage of its powerful features.

Parcel ​

If you prefer a zero-config build tool, Parcel is a great choice. This boilerplate provides a simple setup for integrating Ogma with Parcel, enabling you to get started quickly without complex configurations.

Node.js ​

Server-side integration of Ogma. This boilerplate provides a basic setup for using Ogma in a Node.js environment, allowing you to render visualizations on the server side.