simtechdev / pwajet-extension

Example PWAjet extension for CS-Cart and Multi-Vendor

Example PWAjet extension for CS-Cart and Multi-Vendor

Start your extension with this scaffold.

Features

• Eslint configured the same way as a PWAjet
• Typescript
• Jest
• React testing library
• rollup
• postcss
• babel
• and much more to best coding experience

Getting started

1. Once you have a PWAjet installed, get all its content from the root directory (yes - just compiled statics)
2. Create public folder at the root of your extension project
3. Copy all files from 1. to public
4. Set up name, company name and version at package.json
   1. name should start with pwajet- prefix. Like pwajet-sd-labels.
5. Run yarn and yarn start
6. Done!

Start your development

1. Remove unnecessary or install extra dependencies. You may see current ones at package.json
2. Subscribe to a render event or register your screen/block/payment

pwajet.d.ts

PWAjet has shared API, which is described by pwajet.d.ts. Make sure you're using actual version that meets the version of a PWAjet.

Development vs Production

Development mode allows you to test your extension right at PWAjet like extension already installed: html-webpack-plugin inserts extension's script to index.html (PWAjet entry point)

But extension builds as a pure js and css assets for production.

Production file structure

After yarn build complete, extension under the build directory can be described as:

All emitted assets will be placed to /assets/extensions/extension-developer-name/extension-name/

What next?

After build you can find INSTRUCTION.md at your build path /assets/extensions/extension-developer-name/extension-name/

Credits

• Simtech Development