create-ollie-shop

A CLI tool to scaffold a new Ollie Shop checkout customization project.

Quick Start

npx create-ollie-shop

You'll be prompted for:

1. Project directory (default: my-checkout)
2. Store ID (your Ollie Shop store UUID)
3. Version ID (optional, press Enter to skip)

Usage

Interactive mode

npx create-ollie-shop

🛍️  Create Ollie Shop

Project directory (my-checkout): my-store
Store ID: 7217542a-d7c6-40d3-a20e-db13b310a781
Version ID (optional, press Enter to skip):

🚀 Creating Ollie Shop project "my-store"...
📁 Copying template files...
🔧 Initializing git repository...

✅ Ollie Shop project created in my-store:
  $ cd my-store

Install dependencies:
  $ npm install

Start development:
  $ npm start

🛍️  Happy building with Ollie Shop!

With store ID flag

npx create-ollie-shop --store-id 7217542a-d7c6-40d3-a20e-db13b310a781

With version ID (optional)

npx create-ollie-shop --store-id 7217542a-d7c6-40d3-a20e-db13b310a781 --version-id abc12345-d7c6-40d3-a20e-db13b310a781

Options

| Option | Description | |--------|-------------| | --store-id <uuid> | Store ID (skips prompt if provided) | | --version-id <uuid> | Version ID (optional, for version-specific development) | | --help | Display help | | --version | Display version |

Project Structure

After scaffolding, your project will have:

my-checkout/
├── .vscode/           # VS Code settings (Biome formatter)
├── components/        # Your checkout components
│   └── HelloWorld/    # Example component
├── types/             # TypeScript type definitions
├── .gitignore
├── ollie.json         # Ollie Shop configuration
├── package.json
└── tsconfig.json

Development

After creating your project:

cd my-checkout
npm install
npm start

This starts the Ollie Studio development server and opens it in your browser.

Requirements

• Node.js 20.x or higher

License

MIT