Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide

Create new blueprints in Spire

Describes how to create new blueprints in Spire.

Before creating a blueprint in Spire, ensure you have access to a local installation of Optimizely Configured Commerce. The Configured Commerce Github repository contains the Spire front-end code at \\FrontEnd. It also includes an example blueprint with some basic customizations at \\modules\\blueprints\\example.

To run Spire using the built-in content library, follow these steps:

  1. Use a terminal and go to \\FrontEnd.

  2. Run npm install if you have not already.

  3. Run npm run start.

    This starts the Spire site at localhost:3000 and defaults to connecting to a Configured Commerce instance running at https://commerce.local.com. There is a file at \\FrontEnd\\Config\\settings.js that controls the apiUrl. Changes to this file require re-running npm run start.

    The npm run start command has two optional parameters. For example, if you wanted to run the example blueprint on port 4000, run npm run start example 4000. To run the base content library on another port,
    run npm run start content-library 4000.

    To get started on your own Blueprint, continue with the following steps.

  4. Use a terminal and go to \\FrontEnd.

  5. Run npm run create-blueprint myCustomBlueprint.

  6. Verify your new blueprint was created at \\modules\\blueprints\\myCustomBlueprint.