Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parfaitementweb/wordpress-starter-theme
This Wordpress starter theme is built with Modern PHP development practises in mind.
https://github.com/parfaitementweb/wordpress-starter-theme
laravel tailwindcss wordpress
Last synced: about 11 hours ago
JSON representation
This Wordpress starter theme is built with Modern PHP development practises in mind.
- Host: GitHub
- URL: https://github.com/parfaitementweb/wordpress-starter-theme
- Owner: parfaitementweb
- License: mit
- Archived: true
- Created: 2019-01-24T15:24:19.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-07T07:50:44.000Z (over 3 years ago)
- Last Synced: 2024-12-11T19:26:16.713Z (about 2 months ago)
- Topics: laravel, tailwindcss, wordpress
- Language: PHP
- Size: 205 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Wordpress Starter Theme, done *Parfaitement*.
This Wordpress starter theme is built with Modern PHP development practises in mind.
This starter theme is based on the underscores.me file structure and only includes an additional and optional set of tools to ease your development. You can and will still develop your theme as any other basic Wordpress Theme.
## The theme includes out-of-the-box
- Composer
- Laravel Views Blade
- Controllers
- Laravel Mix
- Custom Gutenberg Blocks using ACF Blocks
- Laravel Collections
- Strings Helpers
- Tailwind CSS
---
[](https://packagist.org/packages/parfaitementweb/wordpress-starter-theme)
[](LICENSE.md)
[](https://packagist.org/packages/parfaitementweb/wordpress-starter-theme)
## Installation
Execute the following commands:
cd wp-content/themes
composer create-project parfaitementweb/wordpress-starter-theme
cd yourtemplatename
npm install
npm run watch
# Build your assets for production using
# npm run production
# Read more about Laravel Mix on their official documentation.
---
## Controllers
Default Wordpress templates files (such as index.php, page.php, etc.) are now your Controllers.
Define in them all the logic for the specified template.
### How to use
1. The Wordpress template file should not directly return HTML or PHP code.
2. You should a call our core library using `$core = new Parfaitement\Core;` . This is going to intantiate an object with a lot of the common functions we need across the site.
3. Return your [Laravel Blade](https://laravel.com/docs/5.7/blade) using the `$core->render($view, $data)` method.
`$view` is the name of the view (without `.blade.php` extension).
`$data` is an array of variables you want to pass to the view.
> Views are saved under the resources/views folder.
The `$core` variable offers additional features:
- Access The [Laravel HTTP Request](https://laravel.com/docs/5.7/requests) using `$core->$request`
It's useful for retrieving input with `$core->request->input('name')` by exemple.
- Inject specific a CSS file for **this template only** using `$core->include_style()`
- Inject specific a JS file for **this template only** using `$core->include_script()`
## Views
Blade views `*.blade.php` are stored under the `resources/views` folder and are parsed using the [Laravel Blade](https://laravel.com/docs/5.7/blade) template engine.
## Assets
All assets are stored in the ``resources/assets`` folder. Normally as follow:
- resources/assets/images
- resources/assets/js
- resources/assets/sass
Assets are compiled using [Laravel Mix](https://laravel-mix.com/docs/4.0/basic-example).
Laravel Mix is a clean layer on top of webpack to make the 80% use case laughably simple to execute.
Out-of-the box, it includes:
- Minification & Compression
- JS with ES2017, Vue Support, Hot Replacement
- CSS Preprocessors. LESS, SASS, Stylus & PostCss
- Browsersync
- Cache-busting (Automatic versioning)
> CSS files are processed using *POSTCSS* by default.
#### mix()
We've added support for the `mix()` helper for cache-busting from within your template.
When using `$core->include_style()` or `$core->include_script()` in your controllers, your scripts ans styles will be automatically cache-busted.
#### Linking to assets from templates
Link your assets (images, icon, ...) using our custom `asset()` helper.
%20}})
`
## Tailwind CSS
This theme comes with [Tailwind CSS](https://tailwindcss.com), an utility-CSS framework pre-installed. You can still remove it form the `package.json` dependencies and edit the CSS style as you like.
> CSS files are processed using *POSTCSS* by default.
>
## Forms
Custom Form can be handle this way:
In your `page.php`
$validator = $core->validation->make(
$core->request->input(),
[
'name' => 'required',
// other rules
]
);
if ($validator->fails()) {
$errors = $validator->errors();
}
$data = [
'errors' => $errors
];
$core->render('page', $data);
In your page.blade.php
@if (isset($errors) && $errors->any())
@foreach ($errors->all() as $error)
{{$error}}
@endforeach
@endif
In `app/ContactForm/php`
'foo',
'title' => 'bar'
];
}
}
?>
## Usage
$custom = new \App\Custom();
$articles = $custom->get_articles();
## Classic Editor
The [Classic Editor plugin](https://wordpress.org/plugins/classic-editor/) is included in the Composer dependencies. Using this command todownload and install it in your Wordpress default plugins folder.
>You still need to manually activate the plugin in the Plugins page.
composer install
## Gutenberg ACF Blocks
This starter theme supports ACF Blocks for easy Gutenberg Block creation. Please read the [ACF Blocks Documentation](https://www.advancedcustomfields.com/resources/blocks/) to learn how to proceed.
In this theme, the blocks are registered in the `inc/acf-blocks.php` file. Views for the blocks are rendered from the `/resources/views/blocks` folder.
> The Blocks views does not support Laravel Balde synthax. Regular PHP is needed.
## Cleaner Wordpress
We've included several classes to offer a cleaner version of Wordpress by default.
You can enable or disable any of them by copying the `.env.example` configuration file at the root of your theme folder to `.env` and customize its content with the following options:
| Option | Default | Description |
|---|---|---|
| DISABLE_COMMENTS | true | Disables all comments features |
| DISABLE_EMOJIS | true | Disables emojis scripts |
| DISABLE_GENERATOR | true | Removes Generator meta tag |
| DISABLE_GUTENBERG_BLOCK | true | Removes Block Library scripts |
| DISABLE_OEMBED | true | Disable oEmebed scripts |
| HIDE_FRONTEND_TOOLBAR | true | Hides the admin toolbar on front and hides the option in the Profile Options page. |
| HIDE_FRONTPAGE_ADMIN_ATTRS | true | Hides the page attributes in the admin when editing the frontpage. |
| ADD_SLUG_BODY_CLASS | true | Add the current slug to the body classes list. |