### Get Laioutr App Starter with git clone Source: https://docs.laioutr.io/raw/apps/app-development/app-starter Clone the Laioutr App Starter repository directly using git. Change into the 'app-starter' directory to start. ```bash git clone https://github.com/laioutr/app-starter.git cd app-starter ``` -------------------------------- ### Install Commerce App in Project A Source: https://docs.laioutr.io/llms-full.txt Example of installing a shared commerce app and a brand-specific UI app in Project A's package.json. ```json // Project A: package.json { "dependencies": { "@your-org/commerce-app": "^2.0.0", "@your-org/brand-a-ui": "^1.0.0" } } ``` -------------------------------- ### Installation Source: https://docs.laioutr.io/raw/getting-started/next-steps/cli Instructions on how to install the Laioutr CLI globally or use it directly without installation. ```APIDOC ## Installation Install the Laioutr CLI globally: ```bash pnpm install -g @laioutr/cli@latest ``` Or run commands directly without installing: ```bash npx @laioutr/cli@latest ``` ``` -------------------------------- ### Nuxt Image Provider Setup Source: https://docs.laioutr.io/llms-full.txt Example of how product and variant media are mapped to the canonical MediaImage type. Installs '@nuxt/image' and suggests using an Emporix Nuxt Image provider if needed. ```javascript provider: "emporix" ``` -------------------------------- ### Install Project Dependencies Source: https://docs.laioutr.io/raw/apps/app-development/app-starter Run this command in your project directory to install all necessary dependencies. ```bash pnpm install ``` -------------------------------- ### Install Commerce App in Project B Source: https://docs.laioutr.io/llms-full.txt Example of installing the same shared commerce app and a different brand-specific UI app in Project B's package.json. ```json // Project B: package.json { "dependencies": { "@your-org/commerce-app": "^2.0.0", "@your-org/brand-b-ui": "^1.0.0" } } ``` -------------------------------- ### Example: Full App Shipping Workflow Source: https://docs.laioutr.io/raw/getting-started/key-concepts/ci-cd-pipeline A comprehensive example demonstrating the steps to ship a new Laioutr app, from code push and CI/CD build to registration, preview deployment, and final production deployment. ```bash # 1. Push your code git push origin main # 2. CI/CD builds and publishes (e.g. in GitHub Actions) pnpm install && pnpm build && npm publish # 3. Register the version with Laioutr laioutr app publish --key orgKey_xxx # 4. Deploy a preview for QA laioutr deploy trigger \ --project acme/storefront \ --key orgKey_xxx \ --preview test-my-app \ --with-app @laioutr-org/acme__my-app@1.0.0 # 5. Once tested, deploy to production laioutr deploy trigger --project acme/storefront --key orgKey_xxx ``` -------------------------------- ### Setup Checklist Source: https://docs.laioutr.io/raw/apps/app-docs/adobe-commerce A summary checklist for setting up and configuring the integration. ```APIDOC ## Summary Checklist - Add `@laioutr-app/adobe-commerce` to Nuxt modules. - Set `baseURL`, `consumerKey`, `consumerSecret`, `accessToken`, `accessTokenSecret`, and optionally `imagesConfig` under `@laioutr-app/adobe-commerce` (e.g. from env). - Ensure the Adobe Commerce GraphQL API is reachable and the access token has catalog and cart permissions. - Rely on orchestr queries, actions, links, resolvers, and query template providers for cart, menu, category, product, and variant data. - Use the `adobecommerce` Nuxt Image provider for product/category images when using Nuxt Image. ``` -------------------------------- ### Install BYOS Agent Source: https://docs.laioutr.io/raw/hosting/bring-your-own-server-byos/byos-agent Install the @laioutr/byos-agent package using npm. ```bash npm install @laioutr/byos-agent ``` -------------------------------- ### Start BYOS Agent Source: https://docs.laioutr.io/raw/hosting/bring-your-own-server-byos/byos-agent Run the BYOS agent using npx to start the HTTP server for handling webhooks. ```bash npx @laioutr/byos-agent ``` -------------------------------- ### ProductTileFlag Usage Example Source: https://docs.laioutr.io/raw/laioutr-ui/ui-kit/indicators/producttileflag Example demonstrating how to use the ProductTileFlag component with different variants and custom content. ```APIDOC ## ProductTileFlag Usage Example ### Description Illustrates the implementation of the ProductTileFlag component in a Vue.js template, showcasing its usage with the 'sale' variant and custom text content. ### Method N/A (Component Usage) ### Endpoint N/A (Component Usage) ### Request Example ```vue-template -25% ``` ### Response N/A (Component Usage) ### Response Example N/A (Component Usage) ``` -------------------------------- ### Initialize a New Laioutr Project Source: https://docs.laioutr.io/raw/getting-started/what-is-laioutr Use this command to start a new Laioutr project, which is a Nuxt application. Navigate into the project directory and start the development server. ```bash npx @laioutr/cli init my-storefront cd my-storefront pnpm dev ``` -------------------------------- ### Install Laioutr CLI Source: https://docs.laioutr.io/raw/apps/app-development/app-starter Install the Laioutr CLI globally to manage laioutrrc.json files. Ensure you have Node.js and pnpm installed. ```bash pnpm add -g @laioutr/cli@latest ``` -------------------------------- ### Install Webhook Types Source: https://docs.laioutr.io/llms-full.txt Install the @laioutr/webhook-types package using npm. ```bash npm install @laioutr/webhook-types ``` -------------------------------- ### Nuxt Configuration Example Source: https://docs.laioutr.io/raw/apps/app-docs/adobe-commerce Example of how to configure the @laioutr-app/adobe-commerce module in your nuxt.config.ts file. Ensure to use environment variables for sensitive credentials. ```APIDOC ## Nuxt Configuration Example ### Description This snippet shows the configuration for the `@laioutr-app/adobe-commerce` module within `nuxt.config.ts`. It includes essential environment variables for authentication and optional image optimization settings. ### Code ```ts // nuxt.config.ts export default defineNuxtConfig({ modules: ['@laioutr-app/adobe-commerce', '@laioutr-core/orchestr', '@nuxt/image'], '@laioutr-app/adobe-commerce': { baseURL: process.env.ADOBE_COMMERCE_BASE_URL!, consumerKey: process.env.ADOBE_COMMERCE_CONSUMER_KEY!, consumerSecret: process.env.ADOBE_COMMERCE_CONSUMER_SECRET!, accessToken: process.env.ADOBE_COMMERCE_ACCESS_TOKEN!, accessTokenSecret: process.env.ADOBE_COMMERCE_ACCESS_TOKEN_SECRET!, imagesConfig: { optInForProbing: false, smallImageSize: { width: 1000, height: 1000 }, thumbnailSize: { width: 600, height: 600 }, }, }, }); ``` ### Notes - Use environment variables for all credentials in production. - Do not commit sensitive credentials directly into your configuration files. ``` -------------------------------- ### Hosting Describe Event Response Example Source: https://docs.laioutr.io/raw/hosting/bring-your-own-server-byos/webhook-config An example of the JSON payload your endpoint should return for the 'hosting.describe' event, detailing supported capabilities. ```json { "ok": true, "data": { "name": "Your CI/CD System", "url": "https://storefront.example.com", "capabilities": { "statusUpdates": true, "cancelDeployment": false, "promoteDeployment": false, "rollbackDeployment": false, "deleteDeployment": false } } } ``` -------------------------------- ### Label Component Usage Examples Source: https://docs.laioutr.io/raw/laioutr-ui/ui-kit/form/label Examples demonstrating how to use the Label component with different sizes and the required indicator. ```APIDOC ## Label Component Usage Examples ### Different Sizes #### Example: Label Small ```vue-template