README.md
# Daffodil
[](https://discord.gg/BdaJVZ53sR)
[](https://graycore.visualstudio.com/Daffodil/_build/latest?definitionId=6&branchName=develop)
[](https://codeclimate.com/github/graycoreio/daffodil/maintainability)
[](https://codeclimate.com/github/graycoreio/daffodil/test_coverage)
[](https://www.github.com/graycoreio/daffodil)
## Table of contents
- [Introduction](#whatisdaff)
- [Features](#features)
- [Prerequisites](#prereqs)
- [Getting started](#getstarted)
- [Uses](#whowhydaff)
- [Packages](#whatpackages)
- [PWAs](#pwapackages)
- [Angular and Ecommerce](#angularecompackages)
- [Better Frontend UX](#frontendpackages)
- [Less Re-Platforming](#replatformpackages)
- [Table of Packages](#packages)
## What is Daffodil? <a id="whatisdaff"></a>
In general, Daffodil is a frontend Ecommerce framework that allows developers to build complex Ecommerce stores.
Specifically, Daffodil is a frontend toolkit that accomplishes three things:
1. Improve developer workflow when writing frontend software for Ecommerce stores.
2. Provide a consistent frontend developer tool-chain regardless of a business's chosen ecommerce platform.
3. Drastically improve the end-user experience of online-shopping.
## What are Daffodil's features? <a id="features"></a>
Daffodil's features include the following:
* :free: Forever Free, Open Source, and MIT Licensed
* :hammer: Platform Agnostic Drivers for your platform of choice
* Shopify
* Magento 2
* In-Memory Backend
* Prebuilt
* :zap: Great for lightning fast iteration and concepting
* :cake: Decoupled and Composable Packages for your use case
* Product
* Cart
* Checkout
* :books: Well Documented
* Example Implementation
* API References
* Tutorials
* :bulb: Component Kit
* Purely Functional
* Themeable
* Accessible
* Supports Server-side Rendering
* Well Tested
* Fantastic Performance
* IE 11+ Support
## What do I need before I start using Daffodil? <a id="prereqs"></a>
Daffodil was developed so you can get started without connecting to a platform. Because of its driver-like nature, all you need is the following:
1. [Node.js v18+](https://nodejs.org/en/)
2. [npm](https://www.npmjs.com/)
3. [An Angular 17 project](https://angular.dev)
## How do I start using Daffodil? <a id="getstarted"></a>
After installing the [prerequisites](#prereqs), you can choose the packages that you want and get started using Daffodil with your new or existing Ecommerce store.
- To use Daffodil to build your own Ecommerce store, follow the steps in the [Installation instructions](/docs/guides/introduction/getting-started.md).
- To view our progress of an example store or contribute one of your own, see the [Developer documentation](/docs/internal/DEVELOPER.md#running-the-example-demo).
## Who uses Daffodil and why? <a id="whowhydaff"></a>
The target devopers for Daffodil include, but are not limited to, the following:
1. Developers who want to explore and experiment with Progressive Web Apps (PWAs).
2. Developers who are comfortable with Angular and are interested in job opportunities in Ecommerce.
3. Developers who work with businesses that have existing websites but want a better user interface and experience.
4. Developers who are forward-thinking, have gone through a re-platforming, and want to deflect future re-platforming.
## What packages do I use? <a id="whatpackages"></a>
For a basic Ecommerce site, you need all of the most commonly used packages (common packages), which are the following:
- [@daffodil/cart](/libs/cart/README.md)
- [@daffodil/category](/libs/category/README.md)
- [@daffodil/geography](/libs/geography/README.md)
- [@daffodil/navigation](/libs/navigation/README.md)
- [@daffodil/product](/libs/product/README.md)
- [@daffodil/core](/libs/order/README.md)
- [@daffodil/driver](/libs/driver/README.md)
**Note:** Both the `core` and `driver` packages are dependencies for most other packages. Developers do not interact with these packages directly.
Referring to the aforementioned [use cases](#whowhydaff), here are some lists and explanations of recommended Daffodil packages.
### **1. To explore and experiment with PWAs**<a id="pwapackages"></a>
If you don't have a project in mind and want to see something in Daffodil working, then use:
- [@daffodil/core](/libs/order/README.md)
- [@daffodil/driver](/libs/driver/README.md)
- [@daffodil/product](/libs/product/README.md)
### **2. To expand Ecommerce opportunities**<a id="angularecompackages"></a>
If you want to expand your portfolio for more Ecommerce opportunities, then use the [common packages](#whatpackages) and optionally include:
- [@daffodil/design](/libs/design/README.md) (optional)
You won't need to use more than the aforementioned common packages(#pwapackages) until you have a specific business use or requirement. However, if you are design-focused, then you can either use your own design framework or use the `design` package.
### **3. To improve the user experience for existing business sites**<a id="frontendpackages"></a>
If you have an existing site, either your own or backed by a business, then there are a few working assumptions about the site: it has SEO and specific URLs, and the product pages need to show lists of related products.
So, in addition to the [common packages](#whatpackages), you may need the following packages:
- [@daffodil/external-router](/libs/external-router/README.md)
- [@daffodil/seo](/libs/seo/README.md)
- [@daffodil/related-products](/libs/related-products/README.md)****
- [@daffodil/upsell-products](/libs/upsell-products/README.md)
- [@daffodil/design](/libs/design/README.md)
- [@daffodil/contact](/libs/contact/README.md)
### **4. To prevent future re-platforming**<a id="replatformpackages"></a>
If you want to prevent future re-platforming of your Ecommerce site, there are a few assumed advanced requirements. For example, the business has complex product configurations and has marketing email campaigns. So, in addition to the [common packages](#whatpackages) and the packages for [improving user experiences](#frontendpackages), you may also need the following packages:
- [@daffodil/newsletter](/libs/newsletter/README.md)
- [@daffodil/product-composite](/libs/product-composite/README.md)
- [@daffodil/product-configurable](/libs/product-configurable/README.md)
## Packages <a id="packages"></a>
Below is a table of currently available Daffodil packages.
<!-- AUTOGENERATE_PACKAGE_START -->
| Package | Version | Stability |
|---|---|---|
| [@daffodil/analytics](/libs/analytics/README.md) | [](https://npmjs.com/package/@daffodil/analytics) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/analytics-provider-data-layer](/libs/analytics-provider-data-layer/README.md) | [](https://npmjs.com/package/@daffodil/analytics-provider-data-layer) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/auth](/libs/auth/README.md) | [](https://npmjs.com/package/@daffodil/auth) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/authorizenet](/libs/authorizenet/README.md) | [](https://npmjs.com/package/@daffodil/authorizenet) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/cart](/libs/cart/README.md) | [](https://npmjs.com/package/@daffodil/cart) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/cart-customer](/libs/cart-customer/README.md) | [](https://npmjs.com/package/@daffodil/cart-customer) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/cart-store-credit](/libs/cart-store-credit/README.md) | [](https://npmjs.com/package/@daffodil/cart-store-credit) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/category](/libs/category/README.md) | [](https://npmjs.com/package/@daffodil/category) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/checkout](/libs/checkout/README.md) | [](https://npmjs.com/package/@daffodil/checkout) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/contact](/libs/contact/README.md) | [](https://npmjs.com/package/@daffodil/contact) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/content](/libs/content/README.md) | [](https://npmjs.com/package/@daffodil/content) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/core](/libs/core/README.md) | [](https://npmjs.com/package/@daffodil/core) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/customer](/libs/customer/README.md) | [](https://npmjs.com/package/@daffodil/customer) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/customer-auth](/libs/customer-auth/README.md) | [](https://npmjs.com/package/@daffodil/customer-auth) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/customer-order](/libs/customer-order/README.md) | [](https://npmjs.com/package/@daffodil/customer-order) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/customer-payment](/libs/customer-payment/README.md) | [](https://npmjs.com/package/@daffodil/customer-payment) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/customer-payment-authorizenet](/libs/customer-payment-authorizenet/README.md) | [](https://npmjs.com/package/@daffodil/customer-payment-authorizenet) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/customer-store-credit](/libs/customer-store-credit/README.md) | [](https://npmjs.com/package/@daffodil/customer-store-credit) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/design](/libs/design/README.md) | [](https://npmjs.com/package/@daffodil/design) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/driver](/libs/driver/README.md) | [](https://npmjs.com/package/@daffodil/driver) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/external-router](/libs/external-router/README.md) | [](https://npmjs.com/package/@daffodil/external-router) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/forms](/libs/forms/README.md) | [](https://npmjs.com/package/@daffodil/forms) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/geography](/libs/geography/README.md) | [](https://npmjs.com/package/@daffodil/geography) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/navigation](/libs/navigation/README.md) | [](https://npmjs.com/package/@daffodil/navigation) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/newsletter](/libs/newsletter/README.md) | [](https://npmjs.com/package/@daffodil/newsletter) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/order](/libs/order/README.md) | [](https://npmjs.com/package/@daffodil/order) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/payment](/libs/payment/README.md) | [](https://npmjs.com/package/@daffodil/payment) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/paypal](/libs/paypal/README.md) | [](https://npmjs.com/package/@daffodil/paypal) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/product](/libs/product/README.md) | [](https://npmjs.com/package/@daffodil/product) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/product-composite](/libs/product-composite/README.md) | [](https://npmjs.com/package/@daffodil/product-composite) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/product-configurable](/libs/product-configurable/README.md) | [](https://npmjs.com/package/@daffodil/product-configurable) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/related-products](/libs/related-products/README.md) | [](https://npmjs.com/package/@daffodil/related-products) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/reviews](/libs/reviews/README.md) | [](https://npmjs.com/package/@daffodil/reviews) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/router](/libs/router/README.md) | [](https://npmjs.com/package/@daffodil/router) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/search](/libs/search/README.md) | [](https://npmjs.com/package/@daffodil/search) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/search-category](/libs/search-category/README.md) | [](https://npmjs.com/package/@daffodil/search-category) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/search-product](/libs/search-product/README.md) | [](https://npmjs.com/package/@daffodil/search-product) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/search-product-composite](/libs/search-product-composite/README.md) | [](https://npmjs.com/package/@daffodil/search-product-composite) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/search-product-configurable](/libs/search-product-configurable/README.md) | [](https://npmjs.com/package/@daffodil/search-product-configurable) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/seo](/libs/seo/README.md) | [](https://npmjs.com/package/@daffodil/seo) | [](https://www.github.com/graycoreio/daffodil)
| [@daffodil/upsell-products](/libs/upsell-products/README.md) | [](https://npmjs.com/package/@daffodil/upsell-products) | [](https://www.github.com/graycoreio/daffodil)
<!-- AUTOGENERATE_PACKAGE_END -->
**Note:** About the `checkout` package, it is currently a legacy package; there is no reason to use it. However, the `checkout` package eventually may be filled with extracts from the `cart` and `order` packages.