miranj / craft-boilerplate
A Craft CMS 3 starter project by Miranj
Installs: 67
Dependents: 0
Suggesters: 0
Security: 0
Stars: 13
Watchers: 3
Forks: 3
Open Issues: 14
Language:Twig
Type:project
Requires
- craftcms/ckeditor: ^3.5
- craftcms/cms: ~4.5.0
- doublesecretagency/craft-inventory: ^3.0
- marionnewlevant/twig-perversion: ^3.0
- miranj/craft-obfuscator: ^1.1
- mmikkel/child-me: ^1.3.1
- mmikkel/cp-field-inspect: ^1.4.4
- mmikkel/retcon: ^2.6
- nystudio107/craft-minify: ^4.0.0-beta.2
- nystudio107/craft-typogrify: ^4.0
- spacecatninja/imager-x: ^4.1
- topshelfcraft/environment-label: ^4.0
- ttempleton/craft-nocache: ^3.0
- vaersaagod/seomate: ^2.2
- verbb/element-index-defaults: ^3.0
- verbb/field-manager: ^3.0
- verbb/image-resizer: ^3.0
- vlucas/phpdotenv: ^5.4.0
- yiisoft/yii2-redis: ^2.0
Requires (Dev)
- yiisoft/yii2-shell: ^2.0
This package is auto-updated.
Last update: 2024-04-15 10:02:32 UTC
README
Miranj Craft Boilerplate
A Craft CMS 4 starter project based on Miranj’s
project boilerplate (see craft3
for the older version). It includes:
- Our modular templating architecture.
- 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 made fields to import 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" and "boilerplate" with the handle of the new project in the following locations:
composer.json
assets/package.json
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.
-
Run
composer dump-autoload