This is an alternate scaffolding package for Craft 3 CMS projects to Pixel & Tonic's canonical craftcms/craft package.
This project uses a Vite.js for the build system as per Vite.js Next Generation Frontend Tooling + Craft CMS, as opposed to the usual webpack buildchain.
Vite is fast ⚡
The project is based on Craft CMS using a unique templates/_boilerplate
system for web/AJAX/AMP pages, and implements a number of technologies/techniques:
...and probably a bunch of other stuff too.
The following Craft CMS plugins are used on this site:
srcset
s used on the sitemanifest.json
resources in a modern wayYou can read more about it in the Setting up a New Craft 3 CMS Project article.
This project package works exactly the way Pixel & Tonic's craftcms/craft package works; you create a new project by first creating & installing the project:
composer create-project nystudio107/craft PATH --no-install
Make sure that PATH
is the path to your project, including the name you want for the project, e.g.:
composer create-project nystudio107/craft craft3 --no-install
We use --no-install
so that the composer packages for the root project are not installed.
You'll need Docker desktop for your platform installed to run devMode in local development
Ensure no other local development environments are running that might have port conflicts, then:
make dev
in terminal in the project's root directory (the first build will be somewhat lengthy)http://localhost:8000
to use the site; the vite-dev-server
runs off of http://localhost:3000
Wait until you see the following to indicate that the PHP container is ready:
php_1 | Craft is installed.
php_1 | Applying changes from your project config files ... done
php_1 | [01-Dec-2020 18:38:46] NOTICE: fpm is running, pid 22
php_1 | [01-Dec-2020 18:38:46] NOTICE: ready to handle connections
...and the following to indicate that the Vite container is ready:
vite_1 | vite v2.3.2 dev server running at:
vite_1 |
vite_1 | > Local: http://localhost:3000/
vite_1 | > Network: http://172.22.0.5:3000/
vite_1 |
vite_1 | ready in 1573ms.
The CP login credentials are initially set as follows:
Login: andrew@nystudio107.com
\
Password: letmein
Obviously change these to whatever you like as needed.
Build the production assets by typing make build
to build the critical CSS, fonts, and other production assets. They will appear in cms/web/dist/
(just double-click on the report-legacy.html
and report-modern.html
files to view them).
N.B.: Without authorization & credentials (which are private), the make pulldb
will not work (it just runs scripts/docker_pull_db.sh
). It's provided here for instructional purposes.
This project uses Docker to shrink-wrap the devops it needs to run around the project.
To make using it easier, we're using a Makefile and the built-in make
utility to create local aliases. You can run the following from terminal in the project directory:
make dev
- starts up the local dev server listening on http://localhost:8000/
make build
- builds the static assets via the Vite buildchainmake clean
- removes the cms/composer.lock
& the entire cms/vendor/
directory as well as the buildchain/package-lock.json
& the entire buildchain/node_modules/
directorymake composer xxx
- runs the composer
command passed in, e.g. make composer install
make craft xxx
- runs the craft
console command passed in, e.g. make craft project-config/apply
in the php containermake npm xxx
- runs the npm
command passed in, e.g. make npm install
make nuke
- restarts the project from scratch by running make clean
(above), then shuts down the Docker containers, removes any mounted volumes (including the database), and then rebuilds the containers from scratchmake pulldb
- runs the scripts/docker_pull_db.sh
script to pull a remote database into the database container; the scripts/.env.sh
must be set up firstmake restoredb xxx
- runs the scripts/docker_restore_db.sh
script to restore a local database dump into the database container; the scripts/.env.sh
must be set up firstmake ssh
- opens up a Unix shell inside the PHP container for the projectTip: If you try a command like make craft project-config/apply --force
you’ll see an error, because the shell thinks the --force
flag should be applied to the make
command. To side-step this, use the --
(double-dash) to disable further option processing, like this: make -- craft project-config/apply --force
To use Xdebug with VSCode install the PHP Debug extension and use the following configuration in your .vscode/launch.json
:
{
"version": "0.2.0",
"configurations": [
{
"name": "Listen for Xdebug",
"type": "php",
"request": "launch",
"port": 9003,
"log": true,
"externalConsole": false,
"pathMappings": {
"/var/www/project/cms": "${workspaceRoot}/cms"
},
"ignore": ["**/vendor/**/*.php"]
}
]
}
Below is the entire intact, unmodified README.md
from Pixel & Tonic's craftcms/craft:
^3.0.0
.....
Craft is a flexible and scalable CMS for creating bespoke digital experiences on the web and beyond.
It features:
Learn more about it at craftcms.com.
Craft is written in PHP (7+), and built on the Yii 2 framework. It can connect to MySQL (5.5+) and PostgreSQL (9.5+) for content storage.
See the following documentation pages for help installing Craft 3: