surecart
Last commit date
app
3 years ago
core
3 years ago
dist
3 years ago
images
3 years ago
languages
3 years ago
packages
3 years ago
templates
3 years ago
vendor
3 years ago
views
3 years ago
LICENSE
3 years ago
README.md
3 years ago
package.json
3 years ago
readme.txt
3 years ago
surecart.php
3 years ago
README.md
171 lines
| 1 | SureCart. Based on the [](https://github.com/htmlburger/wpemergeWP Emerge](https://github.com/htmlburger/wpemerge](https://github.com/htmlburger/wpemerge) framework. |
| 2 | |
| 3 | ## Summary |
| 4 | |
| 5 | - [](#requirementsRequirements](#requirements](#requirements) |
| 6 | - [](#directory-structureDirectory structure](#directory-structure](#directory-structure) |
| 7 | - [](#creditsCredits](#credits](#credits) |
| 8 | |
| 9 | ## Requirements |
| 10 | |
| 11 | - [](http://php.net/PHP](http://php.net/](http://php.net/) >= 7.4 |
| 12 | - [](https://wordpress.org/WordPress](https://wordpress.org/](https://wordpress.org/) >= 5.9 |
| 13 | - [](https://getcomposer.org/Composer](https://getcomposer.org/](https://getcomposer.org/) |
| 14 | - [](https://nodejs.org/en/Node.js](https://nodejs.org/en/](https://nodejs.org/en/) >= 16.10 |
| 15 | - [](https://yarnpkg.com/en/Yarn](https://yarnpkg.com/en/](https://yarnpkg.com/en/) |
| 16 | |
| 17 | ## Getting Started |
| 18 | |
| 19 | ### Composer Install |
| 20 | Be sure you have composer installed on your machine, then install |
| 21 | composer dependencies. |
| 22 | |
| 23 | ``` |
| 24 | composer install |
| 25 | ``` |
| 26 | |
| 27 | ### Installing Yarn |
| 28 | 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. |
| 29 | |
| 30 | To enable it, run the following command: |
| 31 | ``` |
| 32 | corepack enable |
| 33 | ``` |
| 34 | |
| 35 | ### Install JavaScript Dependencies |
| 36 | Run `yarn` in the plugin root directory to install javascript dependencies across the monorepo. |
| 37 | ``` |
| 38 | yarn |
| 39 | ``` |
| 40 | |
| 41 | ### Bootstrap files |
| 42 | This will initialize the build. |
| 43 | ``` |
| 44 | yarn bootstrap |
| 45 | ``` |
| 46 | |
| 47 | ### Developing |
| 48 | Running `yarn dev` will start a development process to watch files and build |
| 49 | them without needing to run additional commands. |
| 50 | ``` |
| 51 | yarn dev |
| 52 | ``` |
| 53 | |
| 54 | ### Building |
| 55 | Running `yarn plugin:release` will build the files for production and copy |
| 56 | them to a subfolder called @surecart. |
| 57 | |
| 58 | ``` |
| 59 | yarn plugin:release |
| 60 | ``` |
| 61 | |
| 62 | ## Troubleshooting |
| 63 | |
| 64 | ### Error running `yarn dev` even after running `yarn bootstrap`. |
| 65 | - Navigate to `packages/components` and run `yarn build`. |
| 66 | - Navigate to `packages/components-react` and run `yarn build`. |
| 67 | |
| 68 | ### `Error: error:0308010C:digital envelope routines::unsupported` |
| 69 | This can happen if you are running OpenSSL and node v17+ ([](https://github.com/webpack/webpack/issues/14532see issue](https://github.com/webpack/webpack/issues/14532](https://github.com/webpack/webpack/issues/14532)) |
| 70 | |
| 71 | Linux & Mac OS (windows git bash)- |
| 72 | |
| 73 | ``` |
| 74 | export NODE_OPTIONS=--openssl-legacy-provider |
| 75 | ``` |
| 76 | |
| 77 | Windows command prompt- |
| 78 | |
| 79 | ``` |
| 80 | set NODE_OPTIONS=--openssl-legacy-provider |
| 81 | ``` |
| 82 | |
| 83 | ## Directory structure |
| 84 | |
| 85 | ``` |
| 86 | wp-content/plugins/surecart |
| 87 | ├── app/ |
| 88 | │ ├── helpers/ # Helper files, add your own here as well. |
| 89 | │ ├── routes/ # Register your WP Emerge routes. |
| 90 | │ │ ├── admin.php |
| 91 | │ │ ├── ajax.php |
| 92 | │ │ └── web.php |
| 93 | │ ├── src/ # PSR-4 autoloaded classes. |
| 94 | │ │ ├── Controllers/ # Controller classes for WP Emerge routes. |
| 95 | │ │ ├── Routing/ # Register your custom routing conditions etc. |
| 96 | │ │ ├── View/ # Register your view composers, globals etc. |
| 97 | │ │ ├── WordPress/ # Register post types, taxonomies, menus etc. |
| 98 | │ │ └── ... |
| 99 | │ ├── config.php # WP Emerge configuration. |
| 100 | │ ├── helpers.php # Require your helper files here. |
| 101 | │ ├── hooks.php # Register your actions and filters here. |
| 102 | │ └── version.php # WP Emerge version handling. |
| 103 | ├── dist/ # Bundles, optimized images etc. |
| 104 | ├── languages/ # Language files. |
| 105 | ├── resources/ |
| 106 | │ ├── build/ # Build process configuration. |
| 107 | │ ├── fonts/ |
| 108 | │ ├── images/ |
| 109 | │ ├── scripts/ |
| 110 | │ │ ├── admin/ # Administration scripts. |
| 111 | │ │ └── frontend/ # Front-end scripts. |
| 112 | │ ├── styles/ |
| 113 | │ │ ├── admin/ # Administration styles. |
| 114 | │ │ ├── frontend/ # Front-end styles. |
| 115 | │ │ └── shared/ # Shared styles. |
| 116 | │ └── vendor/ # Any third-party, non-npm assets. |
| 117 | ├── vendor/ # Composer packages. |
| 118 | ├── views/ |
| 119 | │ ├── layouts/ |
| 120 | │ └── partials/ |
| 121 | ├── screenshot-1.png # Plugin screenshot. |
| 122 | ├── surecart.php # Bootstrap plugin. |
| 123 | └── ... |
| 124 | ``` |
| 125 | |
| 126 | ### Notable directories |
| 127 | |
| 128 | #### `app/helpers/` |
| 129 | |
| 130 | Add PHP helper files here. Helper files should include **function definitions only**. See below for information on where to put actions, filters, classes etc. |
| 131 | |
| 132 | #### `app/src/` |
| 133 | |
| 134 | Add PHP class files here. All clases in the `SureCart\` namespace are autoloaded in accordance with [](http://www.php-fig.org/psr/psr-4/PSR-4](http://www.php-fig.org/psr/psr-4/](http://www.php-fig.org/psr/psr-4/). |
| 135 | |
| 136 | #### `resources/images/` |
| 137 | |
| 138 | Add images for styling here. Optimized copies will be placed in `dist/images/` when running the build process. |
| 139 | |
| 140 | #### `resources/styles/frontend/` |
| 141 | |
| 142 | Add .css and .scss files to add them to the front-end bundle. Don't forget to `@import` them in `index.scss`. |
| 143 | |
| 144 | #### `resources/styles/admin/` |
| 145 | |
| 146 | The admin styles directory which works identically to the `resources/styles/frontend/` directory. |
| 147 | |
| 148 | #### `resources/scripts/frontend/` |
| 149 | |
| 150 | Add JavaScript files here to add them to the frontend bundle. The entry point is `index.js`. |
| 151 | |
| 152 | #### `resources/scripts/admin/` |
| 153 | |
| 154 | The admin scripts directory which works identically to the `resources/scripts/frontend/` directory. |
| 155 | |
| 156 | #### `views/` |
| 157 | |
| 158 | 1. `views/layouts/` - Layouts that other views extend. |
| 159 | 2. `views/partials/` - Small snippets that are meant to be reused throughout other views. |
| 160 | 3. `views/` - Full page views that may extend layouts and may include partials. |
| 161 | |
| 162 | Avoid adding any PHP logic in any of these views, unless it pertains to layouting. Business logic should go into: |
| 163 | |
| 164 | - Helper files (`app/helpers/*.php`) |
| 165 | - Service classes |
| 166 | - [](https://docs.wpemerge.com/#/framework/routing/controllersWP Emerge Controllers](https://docs.wpemerge.com/#/framework/routing/controllers](https://docs.wpemerge.com/#/framework/routing/controllers) |
| 167 | |
| 168 | ## Credits |
| 169 | |
| 170 | SureCart is powered by the [](https://wpemerge.com/WP Emerge framework](https://wpemerge.com/](https://wpemerge.com/). |
| 171 |