miranj / craft-boilerplate
A Craft CMS 5 starter project by Miranj
Installs: 79
Dependents: 0
Suggesters: 0
Security: 0
Stars: 16
Watchers: 5
Forks: 3
Open Issues: 7
Language:JavaScript
Type:project
Requires
- craftcms/ckeditor: ^4.1
- craftcms/cms: ~5.3.0
- marionnewlevant/twig-perversion: ^5.0
- miranj/craft-obfuscator: ^1.2
- mmikkel/child-me: ^2.2
- mmikkel/cp-field-inspect: ^2.0
- mmikkel/retcon: ^3.1
- nystudio107/craft-minify: ^5.0
- nystudio107/craft-typogrify: ^5.0
- spacecatninja/imager-x: ^5.0
- tailwindlabs/heroicons: ^2.1
- topshelfcraft/environment-label: ^5.0
- ttempleton/craft-nocache: ^3.0
- vaersaagod/seomate: ^3.0@beta
- verbb/element-index-defaults: ^4.0
- verbb/field-manager: ^4.0
- verbb/image-resizer: ^4.0
- vlucas/phpdotenv: ^5.6
- yiisoft/yii2-redis: ^2.0
Requires (Dev)
- craftcms/generator: ^2.0.0
- craftcms/phpstan: dev-main
- yiisoft/yii2-shell: ^2.0
This package is auto-updated.
Last update: 2024-12-18 20:26:13 UTC
README
Miranj Craft Boilerplate
A Craft CMS 5 starter project based on Miranj’s
project boilerplate (see craft4
or craft3
for the older versions).
Contents
Features
This starter project includes:
- Our modular templating architecture.
- Our multi-tiered caching architecture with full-page template caches in Craft, and FastCGI micro-caching in Nginx).
- A Gulp based build process that uses
- Server configuration files for Apache (dev) and Nginx (staging, production).
- A few Craft plugins, along with their config files:
- Prettier for auto-formatting (all non-Twig) code.
- Ready to import fields to speed up the project development process.
Usage
-
Open your terminal and run the following command:
composer create-project miranj/craft-boilerplate:dev-dev /path/to/project
-
Replace instances of
miranj/craft-boilerplate
andboilerplate
with the handle of the new project in the following locations:composer.json
package.json
.ddev/config.yaml
config/app.php
src/Module.php
serverconfigs/envs/production/env.conf
serverconfigs/envs/production/setup.conf
serverconfigs/envs/staging/env.conf
serverconfigs/envs/staging/setup.conf
-
Replace instances of "Miranj Craft Boilerplate" / and "Boilerplate" with the title of the new project.
-
Inspect all
FIXME
comments in the project and take necessary action. -
Assign values to all shared environment variables in
.env.example
.