Development
Welcome to the Krypton and Auto Deploy setup guide. This tutorial will walk you through the steps to create a new Krypton storefront, link it to your Crave Up account, and deploy it using Auto Deploy.
Prerequisite You should have installed Node.js (version 18.10.0 or higher) and Krypton Sales Channel from Business Manager.
Step 1: Create a new Krypton storefront
You’ll see a confirmation message with details about your new project:
Step 2. Run the dev server
After installation, open your new project and start the dev server:
The documentation website is now available at http://localhost:3000
.
Step 3. Link Your Krypton Project to Crave Up
- Link your Krypton project to Crave Up:
- Follow the prompts to log in to your Crave Up account and create a new storefront:
Step 4: Link Your Krypton Project to Crave Up
- Update your project’s environment variables:
- Your terminal will show a diff like this:
To test your setup, run npm run dev
, visit http://localhost:3000 in your browser, and you should see your storefront inventory displayed.
Step 5: Deploy to Auto Deploy
After your Krypton online ordering storefront is linked, you can use Auto Deploy to make it publicly accessible.
- Deploy your project to Auto Deploy:
- When prompted to select a deployment environment, choose Preview.
The Krypton CLI builds your online ordering storefront, initiates a new Auto Deploy process, and provides a preview link in your terminal. Open this link in your browser to view your deployment URL.
Next steps
Congratulations! You’ve created a new Krypton storefront, connected it to Crave Up, and made your first deployment to Auto Deploy.