wp-kit Goto Github PK

repos: 33.0 gists: 0.0

Name: wp-kit

Type: Organization

Bio: Simplify your Wordpress development and work laravelishly with wp-kit by Aduro

wp-kit/theme

wp-kit is a micro RAD (Rapid Application Development) solution for Wordpress.

Installation

Download Composer and install using these commands

You need to be using at least PhP 7.4, make sure it's installed, and make sure Composer is using the correct PhP binary:

php -v
composer -vvv about

Both should refer to a version >= PhP 7.4 if your local environment is setup correctly.

cd /path/to/wp-content/themes
composer create-project wp-kit/theme theme --prefer-dist
cd theme
npm i
npm run build

When should you use wp-kit/theme?

If you are looking for an RAD for Wordpress you may have come across Themosis Framework and Assely.

wp-kit/theme is very much like these frameworks but has limited features; the benefit of using wp-kit/theme instead of themosis/theme and assely/assely is that you do not need to install any respective plugin framework as all the work in done in the theme and imported via Composer.

You should use Themosis or Assely is you require any handling of following:

Routes
Middleware
Authentication
Metaboxes
Custom Fields

If you do not need these features then wp-kit/theme could be for you as it comes packaged with several Themosis and Assely features such as:

ServiceProvider Config
PostType Registration
Taxonomy Registration
Invoke Controllers on Conditions
View Handling

wp-kit/theme also comes with further features such as:

Shortcode Registration
Shortcode View Handling
Twig (not in Assely)

Get Involved

To learn more about how to use wp-kit check out the docs:

View the Docs

Any help is appreciated. The project is open-source and we encourage you to participate. You can contribute to the project in multiple ways by:

Reporting a bug issue
Suggesting features
Sending a pull request with code fix or feature
Following the project on GitHub
Sharing the project around your community

For details about contributing to the framework, please check the contribution guide.

Requirements

Wordpress 5+

PHP 7.4+

Composer

Security Vulnerabilities

If you discover a security vulnerability within WP Kit, please send an e-mail to [email protected] or raise an issue on this repo. All security vulnerabilities will be promptly addressed.

License

wp-kit/theme is open-sourced software licensed under the MIT License.

wp-kit's Projects

acf-integration

A wp-kit component that handles ACF configuration

auth

A wp-kit component that handles authentication

bernard

Bernard is a multi-backend PHP library for creating background jobs for later processing.

cleanoquent

A wp-kit component that serves clean Eloquent models for Wordpress

composer-wp-pro-plugins

Composer installer for Pro WordPress plugins.

config

The config handler for wp-kit

docs

The docs for wp-kit

flash

A wp-kit component that handles flash notifications

foundation

The core application for wp-kit

gutenberg-object-plugin

[DEPRECATED] Saves Gutenberg data as an object / array and allows you to access it via REST API

hashing

A wp-kit component that handles password hashing

integrations

The core integration class for wp-kit/integrations

invoker

A wp-kit component that handles the invoking of controllers and closures

kernel

A Themosis component that handles routing by acting as a kernel and allows headers to be sent

magic-meta

A wp-kit component that handles Eloquent appending and querying of PostMeta

queue

A simple queue system for wp-kit and Bedrock using Redis

registry

A wp-kit component that handles Post Type and Taxonomy registration

rest-kit

A micro RAD solution for Wordpress REST API themes

shortcodes

A wp-kit component that handles shortcdoes

softdeletes

A wp-kit component that provides soft deletes for Eloquent models

standalone

[DISCONTINUED] The standalone version of wp-kit

tgm-plugin-activation

TGM Plugin Activation is a PHP library that allows you to easily require or recommend plugins for your WordPress themes (and plugins). It allows your users to install, update and even automatically activate plugins in singular or bulk fashion using native WordPress classes, functions and interfaces. You can reference bundled plugins, plugins from the WordPress Plugin Repository or even plugins hosted elsewhere on the internet.