locomotivemtl / craft-boilerplate
A modern CraftCMS project boilerplate.
Installs: 1
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 8
Forks: 0
Open Issues: 0
Language:TypeScript
Requires
- craftcms/aws-s3: ^2.2
- craftcms/ckeditor: ^4.8.0
- craftcms/cms: ^5.0.0
- ether/seo: ^5.0
- mcaskill/php-html-build-attributes: ^1.3
- mmikkel/cp-clearcache: ^2.0
- nystudio107/craft-vite: ^5.0
- vlucas/phpdotenv: ^5.4.0
Requires (Dev)
- craftcms/generator: ^2.0.0
- yiisoft/yii2-shell: ^2.0.3
README
The goal of this project is to provide a fully working "boilerplate" (empty skeleton project) using the CraftCMS project.
Table of Content
How to Install
To start a CraftCMS project with this Boilerplate, simply:
1. Installing the boilerplate
Charcoal uses the Composer create-project command to install the boilerplate:
composer create-project --prefer-dist locomotivemtl/craft-boilerplate acme
2. Setup your local environment
Using Laravel Valet
# Move into your project's directory cd acme # Setup valet to use PHP 8.2 only for this project valet isolate 8.2 # Install the dependencies valet composer install # Run the valet installer. valet php craft install # Enable the Vite plugin php craft plugin/install vite
Using DDEV
WIP
3. Setup Vite
@todo Quick description of what is Vite and what problems it solves.
Add vite configurations to .env file
VITE_SERVER_URL="http://localhost" VITE_SERVER_PORT=5173 # Make sure to set the environment to 'dev'. Otherwise, Craft won't be looking for the Vite server. CRAFT_ENVIRONMENT=dev
4. Setup front-end tools
npm install
5. Test your installation
Start your Vite server
npm run dev
Visit your project locally http://acme.test
Dependencies and Requirements
PHP 8.2+ext-jsonext-pdoext-splext-mbstring