Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onedarnleyroad/craftcms
A Craft CMS starter project using DDEV for local hosting and Vite for front-end bundling and HMR.
https://github.com/onedarnleyroad/craftcms
alpinejs composer craftcms ddev docker npm tailwindcss vitejs
Last synced: about 2 months ago
JSON representation
A Craft CMS starter project using DDEV for local hosting and Vite for front-end bundling and HMR.
- Host: GitHub
- URL: https://github.com/onedarnleyroad/craftcms
- Owner: onedarnleyroad
- License: mit
- Created: 2018-11-21T13:29:36.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-15T18:34:25.000Z (10 months ago)
- Last Synced: 2024-04-24T16:46:42.953Z (8 months ago)
- Topics: alpinejs, composer, craftcms, ddev, docker, npm, tailwindcss, vitejs
- Language: Twig
- Homepage:
- Size: 495 KB
- Stars: 65
- Watchers: 8
- Forks: 20
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ddev - A Craft CMS starter project using DDEV - end bundling and HM, by [One Darnley Road](https://www.onedarnleyroad.com/) (Craft CMS)
README
## About onedarnleyroad/craftcms
A Craft CMS starter project using DDEV for local hosting and Vite for front-end bundling and HMR.
> https://user-images.githubusercontent.com/134110/132591782-0bcc9465-eb62-46e0-9337-6154bf45fe97.mp4
>
> ☝️ A 1-min video demo, going from zero to Vite HMR on a fresh Craft install, with only 3 CLI commands:
> 1. `composer create-project...`
> 2. `make install`
> 3. `make dev`
## Notable Features:
- [DDEV](https://ddev.readthedocs.io/) for local development
- [Vite 5.x](https://vitejs.dev/) for front-end bundling & HMR
- [Tailwind 3.x](https://tailwindcss.com) for utility-first CSS
- [Alpine 3.x](https://alpinejs.dev/) for lightweight reactivity
- [Servd](https://servd.host/) as the default hosting environment
- [Postmark](https://postmarkapp.com/) for email delivery
- [Makefile](https://www.gnu.org/software/make/manual/make.html) for common CLI commands
## Local machine prerequisites:
1. [Docker](https://www.docker.com/)
2. [DDEV](https://ddev.readthedocs.io/), minimum version 1.19
3. Optional but recommended, [Composer](https://getcomposer.org/)
## Getting Started
### Option 1: With Composer (recommended)
If you have [Composer](https://getcomposer.org/) installed on your local machine,
you can use `create-project` to pull the latest tagged release.
Open terminal prompt, and run:
```shell
composer create-project onedarnleyroad/craftcms PATH --no-install
```
Make sure that `PATH` is a **new** or **existing and empty** folder.
### Option 2: With Git CLI
Alternatively you can clone the repo via the Git CLI:
```shell
git clone [email protected]:onedarnleyroad/craftcms.git PATH
```
Make sure that `PATH` is a **new** _or_ **existing and empty** folder.
Next, you'll want to discard the existing `/.git` directory. In the terminal, run:
```shell
cd PATH
rm -rf .git
```
Last, clean up and set some default files for use:
```shell
cp .env.example .env
mv -f composer.json.default composer.json
mv -f .gitignore.default .gitignore
rm CHANGELOG.md && rm LICENSE.md && rm README.md
```
### Option 3: Manual Download
Download a copy of the repo to your local machine and move to where you want to your project to run. Similar to above, you'll then want to clean up and set some default files for use. In the terminal, run:
```shell
cd PATH
cp .env.example .env
mv -f composer.json.default composer.json
mv -f .gitignore.default .gitignore
rm CHANGELOG.md && rm LICENSE.md && rm README.md
```
## Configuring DDEV
_Note: This section is optional. If you are simply test-driving this project, feel free to skip to the next section. ⚡_
To configure your project to operate on a domain other than `https://craftcms.ddev.site`, run:
```shell
ddev config
```
Follow the prompts.
- **Project name:** e.g. `mysite` would result in a project URL of `https://mysite.ddev.site` (make note of this for later in the installation process)
- **Docroot location:** defaults to `web`, keep as-is
- **Project Type:** defaults to `php`, keep as-is
## Installing Craft
To install a clean version of Craft, run:
```shell
make install
```
Follow the prompts.
This command will:
1. Copy your local SSH keys into the container (handy if you are setting up [craft-scripts](https://github.com/nystudio107/craft-scripts/))
2. Start your DDEV project
3. Install Composer
4. Install npm
5. Do a one-time build of Vite
6. Generate `APP_ID` and save to your `.env` file
7. Generate `SECURITY_KEY` and save to your `.env` file
8. Installing Craft for the first time, allowing you to set the admin's account credentials
9. Install all Craft plugins
Once the process is complete, type `ddev launch` to open the project in your default browser. 🚀
## Local development with Vite
To begin development with Vite's dev server & HMR, run:
```shell
make dev
```
This command will:
1. Copy your local SSH keys into the container (handy if you are setting up [craft-scripts](https://github.com/nystudio107/craft-scripts/))
2. Start your DDEV project
3. Install Composer
4. Install npm
5. Do a one-time build of Vite
6. Spin up the Vite dev server
Open up a browser to your project domain to verify that Vite is connected. Begin crafting beautiful things. ❤️
## Makefile
A Makefile has been included to provide a unified CLI for common development commands.
- `make install` - Runs a complete one-time process to set the project up and install Craft.
- `make up` - Starts the DDEV project, ensuring that SSH keys have been added, and npm & Composer have been installed.
- `make dev` - Runs a one-time build of all front-end assets, then starts Vite's server for HMR.
- `make build` - Builds all front-end assets.
- `make pull` - Pull remote db & assets (requires setting up [craft-scripts](https://github.com/nystudio107/craft-scripts/)
## Craft CMS Plugins
1. [CKEditor](https://plugins.craftcms.com/ckeditor)
1. [CP Field Inspect](https://plugins.craftcms.com/cp-field-inspect)
1. [Craft Autocomplete](https://github.com/nystudio107/craft-autocomplete)
1. [Hyper](https://plugins.craftcms.com/hyper)
1. [Knock Knock](https://plugins.craftcms.com/knock-knock)
1. [Postmark](https://plugins.craftcms.com/postmark)
1. [Seomatic](https://nystudio107.com/docs/seomatic/)
1. [Servd Assets and Helpers](https://github.com/servdhost/craft-asset-storage)
1. [Vite](https://github.com/nystudio107/craft-vite)
## Tailwind Plugins
1. [Aspect Ratio](https://github.com/tailwindlabs/tailwindcss-aspect-ratio)
1. [Line Clamp](https://github.com/tailwindlabs/tailwindcss-line-clamp)
1. [Typography](https://github.com/tailwindlabs/tailwindcss-typography)
## Javascript Libraries
1. [AlpineJS](https://alpinejs.dev/)
1. [Lazysizes](https://afarkas.github.io/lazysizes/)
## Roadmap
- Continue to improve docs
- Bugfixes, new features
## Acknowledgements & Credits
Aside from the obvious gratitude owed to the entire team at [Pixel & Tonic](https://pixelandtonic.com/) for their tireless work on Craft, a special thanks goes out to Andrew Welch of [nystudio107](https://nystudio107.com/). Not only has he developed some of the most widely used plugins in the Craft ecosystem, he has dedicated countless time and energy to pushing all of us in the community to excel at everything we do. He has an uncanny ability to see through the fog of development war to know what's best - not just for us, but for our future selves, our clients, and the users of the sites we build. His contributions have made all of our sites perform better in SEO, run faster in the browser, and made our development workflow more streamlined and efficient. Hats off to you, sir.