Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.32 KB

README.md

File metadata and controls

39 lines (30 loc) · 1.32 KB
Raw

@daffodil/newsletter

@daffodil/newsletter allows you to quickly scaffold a "newsletter" subscription UI feature in an Angular application. It supports drivers for a variety of ecommerce platforms in order to make connecting your UI to your platform's newsletter feature easy.

Installation

To install @daffodil/newsletter, use the following commands in the terminal.

Install with npm:

npm install @daffodil/newsletter --save

Install with yarn:

yarn add @daffodil/newsletter

After installing, a platform driver needs to be set up. We highly recommend installing the in-memory web api for getting started quickly.

Getting started

  1. Import the StoreModule and the DaffNewsletterModule in the root component of your application.
  2. Include StoreModule.forRoot({}) in the imports section. This will be relevant later on when utilizing the redux and state management features of @daffodil/newsletter.
import { DaffNewsletterModule } from '@daffodil/newsletter';
import { StoreModule } from '@ngrx/store';

@ngModule({
  imports: [
    StoreModule.forRoot({}),
    DaffNewsletterModule
  ]
})

Live demo

Check out a live example of @daffodil/newsletter in action!