Code Monkey home page Code Monkey logo

theme's Introduction

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.

theme's People

Contributors

terence1990 avatar mattpilott avatar

Stargazers

 avatar  avatar Pomazan Bogdan avatar Robbie Paul avatar  avatar MacArtur avatar Nathanael Moody avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

simonthesurgery

theme's Issues

Fatal Error in clean install as timber controller is missing

Fatal error: Uncaught Error: Class 'App\Controllers\Timber' not found in /srv/users/serverpilot/apps/chemistry/public/wp-content/themes/chemistry/app/Controllers/AppController.php:82 Stack trace: #0 /srv/users/serverpilot/apps/chemistry/public/wp-includes/class-wp-hook.php(298): App\Controllers\AppController->display_app_header_menu('') #1 /srv/users/serverpilot/apps/chemistry/public/wp-includes/class-wp-hook.php(323): WP_Hook->apply_filters('', Array) #2 /srv/users/serverpilot/apps/chemistry/public/wp-includes/plugin.php(453): WP_Hook->do_action(Array) #3 /srv/users/serverpilot/apps/chemistry/public/wp-content/themes/chemistry/header.php(107): do_action('app_header_menu') #4 /srv/users/serverpilot/apps/chemistry/public/wp-includes/template.php(688): require_once('/srv/users/serv...') #5 /srv/users/serverpilot/apps/chemistry/public/wp-includes/template.php(647): load_template('/srv/users/serv...', true) #6 /srv/users/serverpilot/apps/chemistry/public/wp-includes/general-template.php(45): locate_template(Array, true) #7 /s in /srv/users/serverpilot/apps/chemistry/public/wp-content/themes/chemistry/app/Controllers/AppController.php on line 82

Error thrown on clean install

Okay, so i downloaded the latest version from github and ran the command suggested in the readme.md which all worked well. However when I checked it in the browser I was presented with an error coming from the test widget. I realise this is a dummy thing but thought it probably shouldn't throw an error

screen shot 2018-06-14 at 20 27 47

Make THEME_URI available in twig files

Hello,

I'm sure you will tell me there is already a wonderful way to do this that I don't know about, but I had to add this in so that I could access THEME_URI in my .twig files. If this is no good then don't add it obviously, but if there is no way to do this currently then it would be good to have something like this added in.

File changed: app/Services/Shortcode.php
Line added: 87

screen shot 2017-08-16 at 09 49 28

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.