SureCart. Based on the WP Emerge framework.

Summary

• Requirements
• Directory structure
• Credits

Requirements

• PHP >= 7.4
• WordPress >= 5.9
• Composer
• Node.js >= 16.10
• Yarn

Getting Started

Composer Install

Be sure you have composer installed on your machine, then install composer dependencies.

composer install

Installing Yarn

Be sure you are running Node.js >=16.10. The preferred way to manage Yarn is through Corepack, a new binary shipped with all Node.js releases starting from 16.10. It acts as an intermediary between you and Yarn, and lets you use different package manager versions across multiple projects without having to check-in the Yarn binary anymore.

To enable it, run the following command:

corepack enable

Install JavaScript Dependencies

Run yarn in the plugin root directory to install javascript dependencies across the monorepo.

yarn

Bootstrap files

This will initialize the build.

yarn bootstrap

Developing

Running yarn dev will start a development process to watch files and build them without needing to run additional commands.

yarn dev

Building

Running yarn plugin:release will build the files for production and copy them to a subfolder called @surecart.

yarn plugin:release

Troubleshooting

Error running yarn dev even after running yarn bootstrap.

• Navigate to packages/components and run yarn build.
• Navigate to packages/components-react and run yarn build.

Error: error:0308010C:digital envelope routines::unsupported

This can happen if you are running OpenSSL and node v17+ (see issue)

Linux & Mac OS (windows git bash)-

export NODE_OPTIONS=--openssl-legacy-provider

Windows command prompt-

set NODE_OPTIONS=--openssl-legacy-provider

Directory structure

wp-content/plugins/surecart
├── app/
│   ├── helpers/              # Helper files, add your own here as well.
│   ├── routes/               # Register your WP Emerge routes.
│   │   ├── admin.php
│   │   ├── ajax.php
│   │   └── web.php
│   ├── src/                  # PSR-4 autoloaded classes.
│   │   ├── Controllers/      # Controller classes for WP Emerge routes.
│   │   ├── Routing/          # Register your custom routing conditions etc.
│   │   ├── View/             # Register your view composers, globals etc.
│   │   ├── WordPress/        # Register post types, taxonomies, menus etc.
│   │   └── ...
│   ├── config.php            # WP Emerge configuration.
│   ├── helpers.php           # Require your helper files here.
│   ├── hooks.php             # Register your actions and filters here.
│   └── version.php           # WP Emerge version handling.
├── dist/                     # Bundles, optimized images etc.
├── languages/                # Language files.
├── resources/
│   ├── build/                # Build process configuration.
│   ├── fonts/
│   ├── images/
│   ├── scripts/
│   │   ├── admin/            # Administration scripts.
│   │   └── frontend/         # Front-end scripts.
│   ├── styles/
│   │   ├── admin/            # Administration styles.
│   │   ├── frontend/         # Front-end styles.
│   │   └── shared/           # Shared styles.
│   └── vendor/               # Any third-party, non-npm assets.
├── vendor/                   # Composer packages.
├── views/
│   ├── layouts/
│   └── partials/
├── screenshot-1.png          # Plugin screenshot.
├── surecart.php              # Bootstrap plugin.
└── ...

Notable directories

app/helpers/

Add PHP helper files here. Helper files should include function definitions only. See below for information on where to put actions, filters, classes etc.

app/src/

Add PHP class files here. All clases in the SureCart\ namespace are autoloaded in accordance with PSR-4.

resources/images/

Add images for styling here. Optimized copies will be placed in dist/images/ when running the build process.

resources/styles/frontend/

Add .css and .scss files to add them to the front-end bundle. Don't forget to @import them in index.scss.

resources/styles/admin/

The admin styles directory which works identically to the resources/styles/frontend/ directory.

resources/scripts/frontend/

Add JavaScript files here to add them to the frontend bundle. The entry point is index.js.

resources/scripts/admin/

The admin scripts directory which works identically to the resources/scripts/frontend/ directory.

views/

1. views/layouts/ - Layouts that other views extend.
2. views/partials/ - Small snippets that are meant to be reused throughout other views.
3. views/ - Full page views that may extend layouts and may include partials.

Avoid adding any PHP logic in any of these views, unless it pertains to layouting. Business logic should go into:

• Helper files (app/helpers/*.php)
• Service classes
• WP Emerge Controllers

Credits

SureCart is powered by the WP Emerge framework.