https://github.com/ecomplus/express-app-boilerplate
Boilerplate for E-Com Plus apps with Express
https://github.com/ecomplus/express-app-boilerplate
ecommerce-api ecomplus-integrations expressjs nodejs
Last synced: 6 days ago
JSON representation
Boilerplate for E-Com Plus apps with Express
- Host: GitHub
- URL: https://github.com/ecomplus/express-app-boilerplate
- Owner: ecomplus
- License: mit
- Created: 2019-06-14T19:05:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-26T19:53:23.000Z (almost 3 years ago)
- Last Synced: 2025-05-15T16:06:08.765Z (7 days ago)
- Topics: ecommerce-api, ecomplus-integrations, expressjs, nodejs
- Language: JavaScript
- Homepage:
- Size: 65.4 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# express-app-boilerplate
Boilerplate for E-Com Plus apps with Node.js and Express web framework
[Changelog](https://github.com/ecomclub/express-app-boilerplate/blob/master/CHANGELOG.md)
## Getting started
Setup the source of your new E-Com Plus app with this boilerplate
by running the following commands (bash):
```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](https://developers.e-com.plus/docs/api/#/store/procedures/)
to specify the webhooks your app should receive
at [`lib/store-api/procedures.js`](https://github.com/ecomclub/express-app-boilerplate/blob/master/app/lib/store-api/procedures.js);
- If your app has custom daemon processes,
you may run them from
[`bin/local.js`](https://github.com/ecomclub/express-app-boilerplate/blob/master/app/bin/local.js);
- Edit
[`routes/ecom/webhooks.js`](https://github.com/ecomclub/express-app-boilerplate/blob/master/app/routes/ecom/webhook.js)
to handle received webhooks from Store API properly;
- Add custom web app routes by creating new files to
[`routes`](https://github.com/ecomclub/express-app-boilerplate/tree/master/app/routes)
folder and adding them to Express router at
[`bin/web.js`](https://github.com/ecomclub/express-app-boilerplate/blob/master/app/bin/web.js);
- You may also create new JS files at
[`lib`](https://github.com/ecomclub/express-app-boilerplate/tree/master/app/lib)
folder to add new methods or handlers to be included
on your app source;