Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.65 KB

README.md

File metadata and controls

46 lines (34 loc) · 1.65 KB
Raw

express-app-boilerplate

Boilerplate for E-Com Plus apps with Node.js and Express web framework

Changelog

Getting started

Setup the source of your new E-Com Plus app with this boilerplate by running the following commands (bash):

mkdir my-app
cd my-app
git clone https://github.com/ecomclub/express-app-boilerplate.git
cp -r express-app-boilerplate/app/* ./
rm -rf express-app-boilerplate

You should replace my-app with the name of your application (on kebab-case).

Next steps

  • Configure custom Store API procedures to specify the webhooks your app should receive at lib/store-api/procedures.js;

  • If your app has custom daemon processes, you may run them from bin/local.js;

  • Edit routes/ecom/webhooks.js to handle received webhooks from Store API properly;

  • Add custom web app routes by creating new files to routes folder and adding them to Express router at bin/web.js;

  • You may also create new JS files at lib folder to add new methods or handlers to be included on your app source;