@daffodil/commerce
v0.90.0
Published
Angular schematics for adding Daffodil ecommerce capabilities to existing projects
Readme
Daffodil Ecommerce Schematic
This Angular schematic adds Daffodil's ecommerce capabilities to existing Angular projects.
Installation
ng add @daffodil/ecommerceUsage
The schematic will prompt you to configure:
- Backend: Choose between Magento GraphQL, in-memory (for development), or custom
- Features: Select which ecommerce features to include:
- Shopping Cart
- Product Catalog
- Customer Authentication
- Product Search
- Checkout Process
- Daffodil Design System Components
- Routing: Enable routing setup for ecommerce features
Options
You can also run the schematic with specific options:
ng add @daffodil/ecommerce --backend=magento --features=cart,product-catalog,design-systemAvailable Options
--project: Target project name (defaults to default project)--backend: Backend type (magento|in-memory|custom)--features: Comma-separated list of features--routing: Enable routing setup (default:true)--skip-package-json: Skip updating package.json dependencies
Available Features
cart: Shopping cart functionality with state managementproduct-catalog: Product listing and details with state managementcustomer-auth: Customer authentication and account managementsearch: Product search capabilitiescheckout: Checkout process and order managementdesign-system: Daffodil UI components (buttons, cards, etc.)
What it does
This schematic will:
- Add Dependencies: Install necessary Daffodil packages based on selected features
- Configure Modules: Add feature modules to your app-module.ts
- Setup State Management: Configure NgRx stores for selected features
- Add Components: Create basic component templates for selected features
- Configure Environment: Setup environment configuration for your chosen backend
- Setup Routing: Add routing configuration for ecommerce features (if enabled)
Example
After running ng add @daffodil/ecommerce with cart and product-catalog features:
- Dependencies like
@daffodil/cart,@daffodil/product, and@ngrx/storewill be added - Your
app-module.tswill importDaffCartStateModuleandDaffProductStateModule - A basic
ProductListComponentwill be generated - Environment configuration will be setup for your chosen backend
Backend Configuration
Magento
If you choose Magento backend, update your environment.ts with your Magento GraphQL endpoint:
export const environment = {
production: false,
apiUrl: 'https://your-magento-store.com/graphql'
};In-Memory
The in-memory backend is great for development and testing. No additional configuration needed.
Custom
If you choose custom backend, you'll need to implement the necessary driver services for your API.
Development
To build this schematic package:
npm run build:schematicsTo test locally:
npm link
ng new test-app
cd test-app
ng add @daffodil/ecommerce