@lightspeed/craneBuild custom Lightspeed E‑Commerce themes

A specialized framework for building Server-Side Rendered (SSR) e-commerce themes on the Lightspeed Online Presence (E-Series) platform using Vue 3 and Vite

Get Started

Guide

View on npm

🚀

Fast Development

Quickly scaffold, develop, and preview custom sections with hot module replacement and TypeScript support

🎨

Fully Customizable

Build sections with complete control over HTML, CSS, and JavaScript while leveraging powerful APIs

📦

Monorepo Architecture

Multiple packages including CLI tools, API clients, and shared configurations for streamlined development

🔧

Developer Experience

Built-in TypeScript support, ESLint configurations, and comprehensive tooling for modern web development

🌐

Headless API Client

Access Ecwid's public API with a fully-typed, headless JavaScript client for building custom integrations

✨

Modern Stack

Quick Start

Install Crane in your project:

bash

# Install Crane CLI and dependencies
npm install vite vue @lightspeed/crane@latest @lightspeed/eslint-config-crane@latest

# Initialize a new application
npx @lightspeed/crane@latest init --app my-app
cd my-app

# Build and preview
npx @lightspeed/crane@latest build
npx @lightspeed/crane@latest preview

Packages

Crane is a monorepo containing several packages:

@lightspeed/crane - CLI tool for scaffolding, building, previewing, and deploying applications
@lightspeed/crane-api - Runtime library providing Vue 3 composables for content and design settings
@lightspeed/ecom-headless - Fully-typed headless JavaScript client for the Ecwid public API
@lightspeed/eslint-config-crane - Preconfigured ESLint setup for section development

What You Can Build

With Crane, you can create:

Custom product displays and galleries
Interactive shopping experiences
Custom checkout flows
Personalized product recommendations
Advanced filtering and search interfaces
Custom CMS integrations
And much more...

Resources

npm package - Latest releases and versions
Getting Started Guide - Set up your development environment
Guide - Learn all about Crane commands