About Package

This node module will help you set up you WordPress plugin,cms,theme with one commands, that help reducing you time in inverting on base setup.

Minimum Requirements ( Fully tested and Working as of the current version )

- WordPress : 6.0 and higher
- PHP: 8.1 and higher
- Node: v18.17.0
- Npm: 9.6.7
- Docker: 20.10.22

Feature including:

- :white_check_mark: Local Setup via Docker
- :white_check_mark: Composer based dependency
- :white_check_mark: NPM for NODE modules as dependency management for both Plugin and Theme.
- :white_check_mark: Circle ci for CI/CD to test JS, automation or PHP unit and Linting.
- :white_check_mark: GitHub Workflows to deploying code to AWS EC2 instances via SSH, but you can use other Severs since we use SSH deploy.
- :white_check_mark: PHPCS for coding standards
- :white_check_mark: PHP UNIT using WP PHPUNIT.
- :white_check_mark: Automation test via cypress.
- :x: Js tests using react testing library if working on wp blocks or react based development.
- :white_check_mark: Generate Build packages in -built branch to github ( Example : test branch will have a built package of test-built branch )

Quick start

To Install

``bash
$ npm install -g wp-simple-setup
`

To Create Plugin :white_check_mark:

`bash
$ npx wp-simple-setup --type=plugin
$ cd wp-simple-setup
`

To Create Theme :x:

`bash
$ npx wp-simple-setup --type=theme
$ cd wp-simple-setup
`

To Create WP CMS :white_check_mark:

`bash
$ npx wp-simple-setup --type=cms
$ cd wp-simple-setup
`

As of this version we only support

- :white_check_mark: Plugin creation
- :white_check_mark: CMS creation
- :x: Theme creation.

$3

- -t, --type Project Type, allowed values: "cms", "plugin", "theme"
- -n, --name Project Name, Default value : --slug parameter
- -s, --slug Project Slug
- -ns, --namespace NameSpace
- -a, --author Project Author
- -arl, --author_url Author Url
- -phpv, --phpversion PHP VERSION, Default value : 8.0
- -wpv, --wpversion WP VERSION, Default value : 6.3
- -pv, --pluginversion Plugin VERSION, Default value : 1.0.0
- -idp, --installDependency Installs Dependency after project clone, Default value: true.
- -fp, --fingerprint Circle Ci Footprint to build package, Default value: true.
- -cicd, --circleci Required circleCi, Default value: true.
- -gwf, --gitworkflow Required Git Work Flow ci?, Default value: true.
- -dkr, --docker Required docker?, Default value: true.
- -cyp, --cypress Required Cypress?, Default value: true.

Troubleshoot:

If you have below issue with docker
open /Users/{USER}/.docker/buildx/current: permission denied
Run the follwoing
`bash
sudo chmod -r g+rw "$HOME/.docker"
``

About Me:

My name is Arun Chaitanya Jami, Lead Engineer with 10+ plus years of experience with a solid understanding of all the phases of the Software Development Life-cycle (SDLC), which includes Event Driven Architecture, Analysis, Design, Development, Testing, and Maintenance of UI applications with TDD/BDD development techniques.

Release Notes:

1.1.2 && 1.1.3

- Update Readme.md file.

1.1.1

- CMS SETUP Completed.

1.1.0

- CMS SETUP Work in progress.

1.0.32

- Added auto generated build package for all the branches that were created in git ( Example : test branch will have a built package of test-built branch ).
- Provide flexibility in adding additional components like CICD, CYPRESS, git work flows, dokcer based on requirement.
- - -fp, --fingerprint Circle Ci Footprint to build package, Default value: true.
- - -cicd, --circleci Required circleCi, Default value: true.
- - -gwf, --gitworkflow Required Git Work Flow ci?, Default value: true.
- - -dkr, --docker Required docker?, Default value: true.
- - -cyp, --cypress Required Cypress?, Default value: true.

1.0.31

- Fix Cypress tests for plugin activation check.
- Add Cypress automation on Circle CI
- Fix phpcs linting : exclude cypress and wp cypress config file excluded
- Added new flag --installDependency to install dependency after project setup.