PHPackages                             yivic/wp-proj - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yivic/wp-proj

ActiveWordpress-project[Framework](/categories/framework)

yivic/wp-proj
=============

The WordPress project setup for WordPress modern development with Laravel featuring Yivic Base plugin

00PHP

Since Jan 10Pushed 4mo agoCompare

[ Source](https://github.com/yivic/wp-proj)[ Packagist](https://packagist.org/packages/yivic/wp-proj)[ RSS](/packages/yivic-wp-proj/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (5)Used By (0)

### Initialize

[](#initialize)

- Create the project (stable version)

```
composer create-project yivic/wp-proj

```

- Use development version (branch **master**) ```
    composer create-project -s dev yivic/wp-proj

    ```

in case you want to specify the branch (e.g. branch **develop**)

```
composer create-project -s dev yivic/wp-proj:dev-develop

```

- Ensure that you have the **.env** file, if it doesn't exists, you can copy from the example file

```
cp .env.example .env

```

- Then use the appropriate env variables for you working environment, remember to check the SALTS section to use correct ones.

Development
-----------

[](#development)

- Install (or update) the dependencies

```
docker run --rm --interactive --tty -e XDEBUG_MODE=off -v $PWD:/app -v ~/.composer:/root/.composer manhphucofficial/php80_cli composer install

```

### Deploy with Docker

[](#deploy-with-docker)

The Docker file is built on top of `serversideup/docker-php`  (which are ready for production according to **Server Side** Up team)

- Start all containers

```
docker-compose up -d

```

then the website would be available at (the port 19180 can be edited in **.env** file)

- If WP\_DEBUG set to 0 or 'off' or not set, the container wordpress would have xDebug working as we are in the debug mode
- Update composer with Docker (disable xDebug should help the composer install/update faster)

```
docker-compose exec -e XDEBUG_MODE=off wordpress composer update

```

- Run wp-cli (you must run with the user webuser to avoid running as root)

```
docker-compose exec --user=webuser wordpress wp plugin list

```

or check system info

```
docker-compose exec --user=webuser wordpress wp yivic-base info

```

or add Admin user

```
docker-compose exec --user=webuser wordpress wp user create   --user_pass= --role=administrator

```

- Run wp-app artisan

```
docker-compose exec --user=webuser wordpress ./wp-yivic-base-artisan wp-app:hello

```

or

```
docker-compose exec --user=webuser wordpress wp yivic-base artisan wp-app:hello

```

### Working with GIT

[](#working-with-git)

- You can put your own plugins, themes, mu-plugins to corresponding folders. Then if you use git, you can add these things to your repository by:
    - Update the `./wp-content/.gitignore` to allow your plugins, mu-plugins, themes
    - *e.g.* you have a plugin called `hello-world`, you need to add this

    ```
    !plugins/hello-world
    !plugins/hello-world/**

    ```

    - Then you can `git add ` to the repo

### Compiling assets (CSS, JS)

[](#compiling-assets-css-js)

- This repo consists of a sample plugin **Codemall\_Engine** and a sample theme **Codemall Skin**, it has the webpack configs to compile plugin and theme CSS and JS. The assets would be compiled to `public-assets/dist` folders

To install dependencies

```
docker compose exec wordpress yarn install

```

Compile plugin assets

```
docker compose exec wordpress yarn build-plugin

```

or to watch and compile

```
docker compose exec wordpress yarn dev-plugin

```

Similarly to the theme with

```
docker compose exec wordpress yarn build-theme

```

and watch

```
docker compose exec wordpress yarn dev-theme

```

### Working with Translation

[](#working-with-translation)

- Create the pot file for the Codemall Skin theme

```
docker compose exec --user=webuser wordpress yarn i18n:make-pot

```

*e.g.*

```
docker compose exec --user=webuser wordpress yarn i18n:make-pot public/wp-content/themes/codemall-skin public/wp-content/themes/codemall-skin/languages/codemall-skin.pot

```

**Notes**: if you are using Yarn < 1.0, you need to add `--` before arguments like this

```
docker compose exec --user=webuser wordpress yarn i18n:make-pot -- public/wp-content/themes/codemall-skin public/wp-content/themes/codemall-skin/languages/codemall-skin.pot

```

- Update the pot file to existing po files (same parent folder)

```
docker compose exec --user=webuser wordpress yarn i18n:update-po

```

*e.g.*

```
docker compose exec --user=webuser wordpress yarn i18n:update-po public/wp-content/themes/codemall-skin/languages/codemall-skin.pot

```

- Create mo file (from po file), same parent folder

```
docker compose exec --user=webuser wordpress yarn i18n:make-mo

```

*e.g.*

```
docker compose exec --user=webuser wordpress yarn i18n:make-mo public/wp-content/themes/codemall-skin/languages/codemall-skin-vi.po

```

**Notes**: Of course you can update the script (in package.json) to match your project.

### Working with PHP Code Styling (PHPCS)

[](#working-with-php-code-styling-phpcs)

- Check PHP code style of the project (using phpcs configuration file)

```
docker compose exec wordpress yarn phpcs

```

- Check PHP code style of a certain directory

```
docker compose exec wordpress yarn phpcs

```

*e.g.*

```
docker compose exec wordpress yarn phpcs public/wp-content/plugins/codemall-engine

```

you should use the relative path

- Repair PHP code style

```
docker compose exec wordpress yarn phpcbf

```

*e.g.*

```
docker compose exec wordpress yarn phpcbf public/wp-content/plugins/codemall-engine

```

### Working with Unit Test

[](#working-with-unit-test)

This project uses PHPUnit and configured Codeception Test framework. You should use PHPUnit to run the test because it supports isolationProcess which allow Mockery overload, alias to happen. You can run Codeception if you want.

#### Creating test files

[](#creating-test-files)

- Add a new Unit Test file

```
docker-compose exec --user=webuser wordpress wp yivic-base artisan wp-app:make:phpunit

```

e.g

```
docker-compose exec --user=webuser wordpress wp yivic-base artisan wp-app:make:phpunit tests/Unit/Codemall_Engine/App/WP/Tmp_Test

```

or with Codeception

```
docker compose exec wordpress yarn codecept:generate-unit Codemall_Engine/Test/Test.php

```

this command will create the file `Codemall_Engine/Test/Test.php` to the path of codeception unit setting `suites/tests/unit`. **DO REMEMBER** to use the `setUp()` method instead of the `_before()` to be able to run the test file with the PHPUnit as well.

#### Running Unit Test

[](#running-unit-test)

- Run Unit Test on a single file/folder with PHPUnit

```
docker compose exec wordpress yarn phpunit tests/Unit/Codemall_Engine

```

- If you want to run Unit Test for a file/folder and only want the coverage report on a certain file/folder you can run with PHPUnit

```
docker compose exec wordpress yarn phpunit:coverage-single --whitelist=

```

*e.g.* (with extra `--debug` option)

```
docker compose exec wordpress yarn phpunit:coverage-single --bootstrap=tests/bootstrap-unit.php --debug --whitelist=public/wp-content/plugins/codemall-engine/src/App/WP/Codemall_Engine_WP_Plugin.php tests/Unit/Codemall_Engine/App/WP/Codemall_Engine_WP_Plugin_Test.php

```

- Run Unit Test with PHPUnit (with coverage report to the folder `tests/_output/phpunit`)

```
docker compose exec wordpress yarn phpunit:coverage-html tests/_output/phpunit

```

or you just want to see the result in the console (not an HTML file)

```
docker compose exec wordpress yarn phpunit:coverage

```

**Notes**: You can use Codeception for Unit testing as the configuration is there but Codeception does not support isolationProcess, that means the test with Mokery overload would fail.

```
docker compose exec wordpress yarn codecept:unit

```

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance52

Moderate activity, may be stable

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity17

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/70d332d0092ecb69dc11b79f51330c528f6ad52e4e4a2d03e7e51537b7a4e448?d=identicon)[manhphuc](/maintainers/manhphuc)

---

Top Contributors

[![manhphuc](https://avatars.githubusercontent.com/u/25941730?v=4)](https://github.com/manhphuc "manhphuc (10 commits)")

### Embed Badge

![Health badge](/badges/yivic-wp-proj/health.svg)

```
[![Health](https://phpackages.com/badges/yivic-wp-proj/health.svg)](https://phpackages.com/packages/yivic-wp-proj)
```

###  Alternatives

[laravel/passport

Laravel Passport provides OAuth2 server support to Laravel.

3.4k85.0M532](/packages/laravel-passport)[nolimits4web/swiper

Most modern mobile touch slider and framework with hardware accelerated transitions

41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M259](/packages/laravel-dusk)[laravel/prompts

Add beautiful and user-friendly forms to your command-line applications.

712181.8M596](/packages/laravel-prompts)[cakephp/chronos

A simple API extension for DateTime.

1.4k47.7M121](/packages/cakephp-chronos)[laravel/pail

Easily delve into your Laravel application's log files directly from the command line.

91545.3M590](/packages/laravel-pail)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)