nnc-ecommerce

This bundle provides e-commerce functionality within Apostrophe CMS.

Features

• manage products, categories and subcategories
• manage orders
• cart with paypal smart button for checkout
• single and multiple email
• shippings
• taxes
• pos

Prerequisites

A working Apostrophe CMS project.
Install apostrophe-headless (optional for pos): npm install apostrophe-headless

Use and Configuration

• Declare and configure modules (this configuration is for all modules, you can choose which module you want) NOTE Modules’ order is important, for example modules that use mail must be added after nodemailer definition

// in app.js
// We must declare the bundle!
bundles: [ 'ncc-ecommerce' ],
modules: {
  // Other modules
  // .....

  // ecommerce
  'apostrophe-headless': {},
  'apostrophe-admin-bar': {
    addGroups: [
      {
        label: 'Ecommerce',
        items: [
          'ncc-category',
          'ncc-subcategory',
          'ncc-product',
          'ncc-orders',
          'ncc-shippings',
        ]
      },
    ]
  },
  'ncc-global': {},
  'ncc-category': {},
  'ncc-subcategory': {},
  'ncc-subcategory-widgets': {},
  'ncc-product': {},
  'ncc-products-pages': {},
  'ncc-shippings': {},
  'ncc-cart': {},
  'ncc-pos': {},
  'apostrophe-email': {
    // See the nodemailer documentation, many
    // different transports are available, this one
    // matches how PHP does it on Linux servers
    nodemailer: {
      sendmail: true,
      newline: 'unix',
      path: '/usr/sbin/sendmail'
    }
  },
  'ncc-orders': {},
  'ncc-emails': {},
  'apostrophe-pages': {
    // We must list `ncc-ecommerce-page` as one of the available page types
    types: [
      {
        name: 'ncc-products-pages',
        label: 'Product'
      },
      {
        name: 'default',
        label: 'Default'
      },
      {
        name: 'home',
        label: 'Home'
      }
    ]
  },
}

• As admin set globals varialbes

Additional routes for user menu

• /orders: get all orders for the logged user

Add subcategory menu widget

// in home.html, or where you want
  {# Ecommerce subcategory menu #}
  {{ apos.area(data.page, 'category', {
    widgets: {
      'ncc-subcategory': {}
    }
  }) }}

Emails

You can send an email from pieces, or use the method to send mail where you want. It’s used nodemailer, so you can configure it how you want, for example with ses. For tests you can use Maildev with this config:

  'apostrophe-email': {
    nodemailer: {
      host: 'localhost',
      port: 1025,
      secure: false,
      tls: {
        rejectUnauthorized: false
      }
    }
  },

Use Paypal

// in app.js add the module
  'ncc-paypal': {
    mode: process.env.PAYPAL_MODE, // sandbox or live
    secret: process.env.PAYPAL_SECRET,
    clientID: process.env.PAYPAL_CLIENTID,
  },

You must export the variable in your env, example:

export PAYPAL_MODE=sandbox
export PAYPAL_SECRET=MYSECRET
export PAYPAL_CLIENTID=MYCLIENTID

Disable selling

If you want disable selling from cart (for example if you want a showcase), you must remove from app.js the modules: ncc-paypal and ncc-cart and remove from lib/modules/ncc-products-pages/views/show.html the Add to cart button.

Useful

• User signup: https://github.com/apostrophecms/apostrophe-signup
• Manage users: https://apostrophecms.org/docs/tutorials/intermediate/permissions.html

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Arturo Burela – Initial work – NoteCode Company
• Andrea Di Mario – Contributor – Github Profile

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License – see the LICENSE file for details