vinkla / wordplate

WordPlate WordPlate is a boilerplate for WordPress, built with Composer and designed with sensible defaults. • Features • Installation • Configuration • Public Directory • Environment Configuration • Salt Keys • Plugins • WP Composer • Must Use Plugins • Included Plugins • Vite.js • Mail • FAQ • Upgrade Guide • Acknowledgements • License Features • **WordPress + Composer = ❤️** WordPress can be installed and updated with ease using Composer. To update WordPress, simply run the command . • **Environment Files** Similar to Laravel, WordPlate stores environment variables, such as database credentials, in an file. • **WP Composer** WP Composer enables the management of WordPress plugins and themes through Composer. • **Must-use plugins** Don't worry about clients deactivating plugins; must-use plugins are enabled by default. • **Vite.js** Using Vite, you can rapidly set up and begin building and minifying your CSS and JavaScript. • **Tailwind CSS** Tailwind CSS is included by default, allowing you to quickly build custom designs. • **Debugging** Familiar debugging helper functions are integrated such as and . • **Clean UI** Enhance the WordPress dashboard and improves the user experience for clients. Installation Before using WordPlate, make sure you have PHP 8.4 and MySQL 8.0 installed on your computer. You'll also need to have Composer, a package manager for PHP, installed on your computer. To install WordPlate, open your terminal and enter the following command: After installing WordPlate, you'll need to update the database credentials in the file. This file is located in the root directory of your project. Open the file and update the following lines with your database credentials: To run your WordPlate application, you may serve it using PHP's built-in web server. Open your terminal and navigate to the directory of your project. Then, enter the following command: Finally, open your web browser and visit the following URLs to view your WordPlate application: • - Your website • - The dashboard Configuration Public Directory After installing WordPlate, you'll need to configure your web server's document or web root to be the directory. This is where the main entry point for your application, , is located. By setting the directory as your web server's document root, you ensure that all HTTP requests are routed through the front controller, which handles the requests and returns the appropriate responses. This configuration helps to improve the security and performance of your application by preventing direct access to files outside of the directory. Environment Configuration WordPlate makes it easy to manage different configuration values based on the environment where your application is running. For example, you may need to use a different database locally than you do on your production server. To accomplish this, WordPlate uses the PHP package. When you install WordPlate, a file is included in the root directory of your application. If you installed WordPlate via Composer, this file will automatically be renamed to . Otherwise, you should rename the file manually. It's important to note that your file should not be committed to your application's source control. This is because each developer or server using your application may require a different environment configuration. Additionally, committing your file to source control would be a security risk in the event that an intruder gains access to your repository, as any sensitive credentials would be exposed. To learn more about managing environment variables in WordPlate, you can refer to Laravel's documentation on the topic: • Environment Variable Types • Retrieving Environment Configuration Salt Keys It's important to add salt keys to your environment file. These keys are used to encrypt sensitive data, such as user sessions, and help to ensure the security of your application. If you don't set the salt keys, your user sessions and other encrypted data may be vulnerable to attacks. To make it easier to generate secure salt keys, we've created a salt key generator that you can use. If you haven't already done so, copy the file to a new file named . Then visit the generator and copy the randomly generated keys to your file. Plugins WP Composer WordPlate includes integration with WP Composer, a Composer repository that mirrors the WordPress plugin and theme directories. With this integration, you can install and manage plugins using Composer. To install a plugin, use as the vendor name and the plugin slug as the package name. For example, to install the plugin, you would use the following command: The installed packages will be located in the directory. Here's an example of what your file might look like: For more information and examples, please visit the WP Composer website. Must Use Plugins Must-use plugins (also known as mu-plugins) are a type of WordPress plugin that is installed in a special directory inside the content folder. These plugins are automatically enabled on all sites in the WordPress installation. To install plugins into the directory, add the plugin name to the of your file: To install the plugin, use as the vendor name and the plugin slug as the package name: The plugin will be installed in the directory. For more information on the must-use plugin autoloader, please refer to the Bedrock documentation. Included Plugins Headache An easy-to-swallow painkiller plugin for WordPress. The plugin removes a lot of default WordPress stuff you just can't wait to get rid of. It removes meta tags such as feeds, version numbers and emojis. • Disables XML-RPC and protects against user enumeration • Removes feeds, emoji scripts, oEmbed, and block styles • Disables attachment pages and randomizes media slugs • Prevents indexing on non-production environments Clean Image Filenames The plugin automatically converts language accent characters in filenames when uploading to the medi…