Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maniruzzamanakash/wp-react-kit
A simple starter kit to work in WordPress with WordPress Rest API, WP-script, React, React Router, Tailwind CSS, PostCSS, Eslint, WP-Data, WP-Data Store, Typescript, React Components, i18n, CRUD, PHP OOP plugin architecture easily in a minute.
https://github.com/maniruzzamanakash/wp-react-kit
crud gutenberg hacktoberfest hacktoberfest-accepted hacktoberfest2022 i18n phpunit-tests phpunit9 react reactjs reactrouter redux redux-sagas rest-api typescript wordpress wordpress-api wp-scripts
Last synced: about 1 month ago
JSON representation
A simple starter kit to work in WordPress with WordPress Rest API, WP-script, React, React Router, Tailwind CSS, PostCSS, Eslint, WP-Data, WP-Data Store, Typescript, React Components, i18n, CRUD, PHP OOP plugin architecture easily in a minute.
- Host: GitHub
- URL: https://github.com/maniruzzamanakash/wp-react-kit
- Owner: ManiruzzamanAkash
- License: mit
- Created: 2022-04-21T17:44:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-01T04:22:42.000Z (about 2 years ago)
- Last Synced: 2023-02-28T00:02:11.484Z (almost 2 years ago)
- Topics: crud, gutenberg, hacktoberfest, hacktoberfest-accepted, hacktoberfest2022, i18n, phpunit-tests, phpunit9, react, reactjs, reactrouter, redux, redux-sagas, rest-api, typescript, wordpress, wordpress-api, wp-scripts
- Language: TypeScript
- Homepage:
- Size: 1.38 MB
- Stars: 51
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# WP-React-Kit
A simple starter kit to work in WordPress plugin development using WordPress Rest API, WP-script, React, React Router, Tailwind CSS, PostCSS, Eslint, WP-Data, WP-Data Store, React Components, React CRUD, i18n, PHPUnit Test, JestUnit Test, WordPress Playwright e2e Test, Gutenberg blocks and PHP OOP plugin architecture easily in a minute.
----
## What's included?
1. WordPress Rest API
2. WP-script Setup
3. React
4. React Router
5. TypeScript
6. Tailwind CSS [Nested + ]
7. Scss
8. PostCSS
9. Eslint
10. WP-Data
11. WP-Data Redux Store [Redux Saga, Generator function, Thunk, Saga Middleware]
12. React Components
13. React CRUD Operations - Create, Reade, Update, Delete, Status changes and so many...
14. Internationalization - WP i18n
15. PHPUnit Test [Test + Fix]
16. JestUnit Test
17. WordPress Playwright e2e Test
18. PHP OOP plugin architecture [Traits + Interfaces + Abstract Classes]
19. Gutenberg blocks, Dynamic blocks
### Quick Start
```sh
# Clone the Git repository
git clone https://github.com/ManiruzzamanAkash/wp-react-kit.git
# Install PHP-composer dependencies [It's empty]
composer install
# Install node module packages
npm i
# Start development mode
npm start
# Start development with hot reload (Frontend components will be updated automatically if any changes are made)
npm run start:hot
# To run in production
npm run build
```
After running `start`, or `build` command, there will be a folder called `/build` will be generated at the root directory.
### Activate the plugin
You need activate the plugin from plugin list page.
http://localhost/wpex/wp-admin/plugins.php
### Zip making process [Build, Localization, Version replace & Zip]
```sh
# One by one.
npm run build
npm run makepot
npm run version
npm run zip
# Single release command - which actually will run the above all in single command.
npm run release
```
After running `release` command, there will be a folder called `/dist` will be generated at the root directory with `wp-react-kit.zip` project files.
### Run PHP Unit Test
```sh
composer run test
```
### Run all tests by single command - PHPCS, PHPUnit
```sh
composer run test:all
```
### Run Jest Unit Test
```sh
npm run test:unit
```
### Run Playwright e2e Test
Playwright doc link: https://playwright.dev/docs/running-tests
**Requirements:**
- Must have docker installed and running by ensuring these commands -
```
npm run env:stop
npm run env:start
```
**Normal e2e test**
```sh
npm run test:e2e
```
**Interactive e2e test**
```sh
npm run test:e2e:watch
```
For more about e2e Tests running please check - https://playwright.dev/docs/running-tests
### PHP Coding Standards - PHPCS
**Get all errors of the project:**
```sh
composer run phpcs
```
**Fix all errors of the project:**
```sh
composer run phpcbf
```
**Full Composer test run:**
```sh
composer run test:all
```
### Browse Plugin
http://localhost/wpex/wp-admin/admin.php?page=jobplace#/
Where, `/wpex` is the project root folder inside `/htdocs`.
Or, it could be your custom processed URL.
### REST API's
**Postman API Link** - https://www.getpostman.com/collections/f94073131fc1411506e8
#### REST API Documentation
1. **Job Types**
- Method: `GET`
- URL: http://localhost/wpex/wp-json/job-place/v1/job-types
1. **Companies dropdown**
- Method: `GET`
- URL: http://localhost/wpex/wp-json/job-place/v1/companies/dropdown
1. **Job Lists**
- Method: `GET`
- URL: http://localhost/wpex/wp-json/job-place/v1/jobs
1. **Job Details**
- Method: `GET`
- URL By ID: http://localhost/wpex/wp-json/job-place/v1/jobs/1
- URL By Slug: http://localhost/wpex/wp-json/job-place/v1/jobs/first-job
1. **Create Job**
- Method: `POST`
- URL: http://localhost/wpex/wp-json/job-place/v1/Jobs
- Body:
```json
{
"title": "Simple Job Post",
"slug": "simple-job-post",
"description": "Simple job post description",
"company_id": 1,
"job_type_id": 2,
"is_active": 1
}
```
1. **Update Job**
- Method: `PUT`
- URL: http://localhost/wpex/wp-json/job-place/v1/jobs/1
- Body:
```json
{
"title": "Simple Job Post Updated",
"slug": "simple-job-post-updated",
"description": "Simple job post description",
"company_id": 1,
"job_type_id": 2,
"is_active": 1
}
```
1. **Delete Jobs**
- Method: `DELETE`
- URL: http://localhost/wpex/wp-json/job-place/v1/jobs
- Body:
```json
{
"ids": [1, 2]
}
```
**Detailed Documentation** -
[View Detailed documentations with parameters and responses of the REST API](https://github.com/ManiruzzamanAkash/wp-react-kit/blob/main/Rest-API-Docs.MD)
### Version & Changelogs
**v0.8.0 - 24/05/2023**
1. New feature: WordPress Playwright test-e2e-utils added.
1. New feature: Some Gutenberg blocks has support for Playwright test.
**v0.7.0 - 01/01/2023**
1. Fix: Dynamic block renderer issue.
1. Fix: Asset registering multiple times issue.
**v0.5.0 - 15/11/2022**
1. New Feature : Job Create.
2. New Feature : Job Update.
3. New Feature : Job Delete.
4. New Feature : Job Status change.
5. New API: Company dropdown list.
6. New: Updated logo icon and plugin name.
7. New Components: Input Text-Editor, Improved design.
8. Refactor: Refactored codebase and updated docs.
9. New: Job type seeder.
10. Chore: Zip file generator.
11. Chore: i18n localization generator.
### Version & Changelogs
**v0.4.1 - 18/08/2022**
1. Added Jest Unit Test Setup.
2. Added some dummy Jest Unit Test.
3. Fix #11 - Version naming while installing.
**v0.4.0 - 12/08/2022**
1. Added many re-usable general components.
1. Header Component refactored and re-designed.
1. WP-Data setup and made Job Store.
1. Job List Page frontend added.
**v0.3.1 - 11/08/2022**
1. PHPUnit Test cases setup.
1. PHPUnit Test cases added for Job Manager and Job REST API's.
**v0.3.0 - 02/08/2022**
1. Necessary traits to handle - sanitization, query.
1. Advanced setup for migration, seeder, REST API.
1. Jobs, Job Types REST API developed.
Options for specific files:
**Get specific file errors of the project:**
```sh
vendor/bin/phpcs job-place.php
```
**Fix specific file errors of the project:**
```sh
vendor/bin/phpcbf job-place.php
```
### Versions
Simple Version with raw PHP
https://github.com/ManiruzzamanAkash/wp-react-kit/releases/tag/vSimple
Version with EsLint and i18n Setup
https://github.com/ManiruzzamanAkash/wp-react-kit/releases/tag/vSimpleEslint
Version with EsLint, i18n and React Router Setup
https://github.com/ManiruzzamanAkash/wp-react-kit/releases/tag/vReactRouter
Version with PostCSS and Tailwind CSS Setup
https://github.com/ManiruzzamanAkash/wp-react-kit/releases/tag/vTailwindCss
Version with PHPCS setup
https://github.com/ManiruzzamanAkash/wp-react-kit/releases/tag/vPHPCS
Version with PHP OOP Architecture
https://github.com/ManiruzzamanAkash/wp-react-kit/releases/tag/vPhpOOP
### File structure:
Simple Version Code-Structure:
### Demo with Simple Version
Demo in WordPress plugin:
### Demo With React Router & Menu
### Final Demos
**Job List Page**
**Job List Page with Pagination in different primary color**
**Job List Page with search**
**Job Create Page**
**Job Edit Page**
**Job Delete**
**Responsive views**
## Gutenberg blocks
Inside `src/blocks` you'll find gutenberg block for ready block setup. We've made blocks like dynamic block so that future changes would not create any issue.
**Demo preview -**
## Contribution
Contribution is open and kindly accepted. Before contributing, please check the issues tab if anything in enhancement or bug. If you want to contribute new, please create an issue first with your enhancement or feature idea.
Then, fork this repository and make your Pull-Request. I'll approve, if everything goes well.
## Contact
It's me, Maniruzzaman Akash. Find me at [email protected]