{"id":13561481,"url":"https://github.com/onedarnleyroad/craftcms","last_synced_at":"2025-03-18T21:28:56.370Z","repository":{"id":37549558,"uuid":"158552305","full_name":"onedarnleyroad/craftcms","owner":"onedarnleyroad","description":"A Craft CMS starter project using DDEV for local hosting and Vite for front-end bundling and HMR.","archived":false,"fork":false,"pushed_at":"2024-02-15T18:34:25.000Z","size":507,"stargazers_count":65,"open_issues_count":11,"forks_count":20,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-04-24T16:46:42.953Z","etag":null,"topics":["alpinejs","composer","craftcms","ddev","docker","npm","tailwindcss","vitejs"],"latest_commit_sha":null,"homepage":"","language":"Twig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onedarnleyroad.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-21T13:29:36.000Z","updated_at":"2024-06-07T09:12:01.564Z","dependencies_parsed_at":"2024-06-07T09:12:00.589Z","dependency_job_id":"93e4154a-f7e2-40b0-b21d-2dc79750ed7f","html_url":"https://github.com/onedarnleyroad/craftcms","commit_stats":{"total_commits":310,"total_committers":4,"mean_commits":77.5,"dds":"0.13548387096774195","last_synced_commit":"8bc36fc228965130d1cff01a68ee3920143a34f7"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onedarnleyroad%2Fcraftcms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onedarnleyroad%2Fcraftcms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onedarnleyroad%2Fcraftcms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onedarnleyroad%2Fcraftcms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onedarnleyroad","download_url":"https://codeload.github.com/onedarnleyroad/craftcms/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244078319,"owners_count":20394445,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alpinejs","composer","craftcms","ddev","docker","npm","tailwindcss","vitejs"],"created_at":"2024-08-01T13:00:57.362Z","updated_at":"2025-03-18T21:28:56.346Z","avatar_url":"https://github.com/onedarnleyroad.png","language":"Twig","funding_links":[],"categories":["Craft CMS"],"sub_categories":[],"readme":"## About onedarnleyroad/craftcms\n\nA Craft CMS starter project using DDEV for local hosting and Vite for front-end bundling and HMR.\n\n\u003e https://user-images.githubusercontent.com/134110/132591782-0bcc9465-eb62-46e0-9337-6154bf45fe97.mp4\n\u003e \n\u003e ☝️ A 1-min video demo, going from zero to Vite HMR on a fresh Craft install, with only 3 CLI commands:  \n\u003e 1. `composer create-project...`\n\u003e 2. `make install`\n\u003e 3. `make dev`\n\n## Notable Features:\n\n- [DDEV](https://ddev.readthedocs.io/) for local development\n- [Vite 5.x](https://vitejs.dev/) for front-end bundling \u0026 HMR\n- [Tailwind 3.x](https://tailwindcss.com) for utility-first CSS\n- [Alpine 3.x](https://alpinejs.dev/) for lightweight reactivity\n- [Servd](https://servd.host/) as the default hosting environment\n- [Postmark](https://postmarkapp.com/) for email delivery\n- [Makefile](https://www.gnu.org/software/make/manual/make.html) for common CLI commands\n\n## Local machine prerequisites:\n\n1. [Docker](https://www.docker.com/)\n2. [DDEV](https://ddev.readthedocs.io/), minimum version 1.19\n3. Optional but recommended, [Composer](https://getcomposer.org/)\n\n## Getting Started\n\n### Option 1: With Composer (recommended)\n\nIf you have [Composer](https://getcomposer.org/) installed on your local machine,\nyou can use `create-project` to pull the latest tagged release.\n\nOpen terminal prompt, and run:\n\n```shell\ncomposer create-project onedarnleyroad/craftcms PATH --no-install\n```\n\nMake sure that `PATH` is a **new** or **existing and empty** folder.\n\n### Option 2: With Git CLI\n\nAlternatively you can clone the repo via the Git CLI:\n\n```shell\ngit clone git@github.com:onedarnleyroad/craftcms.git PATH\n```\n\nMake sure that `PATH` is a **new** _or_ **existing and empty** folder.\n\nNext, you'll want to discard the existing `/.git` directory. In the terminal, run:\n\n```shell\ncd PATH\nrm -rf .git\n```\n\nLast, clean up and set some default files for use:\n\n```shell\ncp .env.example .env\nmv -f composer.json.default composer.json\nmv -f .gitignore.default .gitignore\nrm CHANGELOG.md \u0026\u0026 rm LICENSE.md \u0026\u0026 rm README.md\n```\n\n### Option 3: Manual Download\n\nDownload 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:\n\n```shell\ncd PATH\ncp .env.example .env\nmv -f composer.json.default composer.json\nmv -f .gitignore.default .gitignore\nrm CHANGELOG.md \u0026\u0026 rm LICENSE.md \u0026\u0026 rm README.md\n```\n\n## Configuring DDEV\n\n_Note: This section is optional. If you are simply test-driving this project, feel free to skip to the next section. ⚡_\n\nTo configure your project to operate on a domain other than `https://craftcms.ddev.site`, run:\n\n```shell\nddev config\n```\n\nFollow the prompts.\n\n- **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)\n- **Docroot location:** defaults to `web`, keep as-is\n- **Project Type:** defaults to `php`, keep as-is\n\n## Installing Craft\n\nTo install a clean version of Craft, run:\n\n```shell\nmake install\n```\n\nFollow the prompts.\n\nThis command will:\n\n1. Copy your local SSH keys into the container (handy if you are setting up [craft-scripts](https://github.com/nystudio107/craft-scripts/))\n2. Start your DDEV project\n3. Install Composer\n4. Install npm\n5. Do a one-time build of Vite\n6. Generate `APP_ID` and save to your `.env` file\n7. Generate `SECURITY_KEY` and save to your `.env` file\n8. Installing Craft for the first time, allowing you to set the admin's account credentials\n9. Install all Craft plugins\n\nOnce the process is complete, type `ddev launch` to open the project in your default browser. 🚀\n\n## Local development with Vite\n\nTo begin development with Vite's dev server \u0026 HMR, run:\n\n```shell\nmake dev\n```\n\nThis command will:\n\n1. Copy your local SSH keys into the container (handy if you are setting up [craft-scripts](https://github.com/nystudio107/craft-scripts/))\n2. Start your DDEV project\n3. Install Composer\n4. Install npm\n5. Do a one-time build of Vite\n6. Spin up the Vite dev server\n\nOpen up a browser to your project domain to verify that Vite is connected. Begin crafting beautiful things. ❤️\n\n## Makefile\n\nA Makefile has been included to provide a unified CLI for common development commands.\n\n- `make install` - Runs a complete one-time process to set the project up and install Craft.\n- `make up` - Starts the DDEV project, ensuring that SSH keys have been added, and npm \u0026 Composer have been installed.\n- `make dev` - Runs a one-time build of all front-end assets, then starts Vite's server for HMR.\n- `make build` - Builds all front-end assets.\n- `make pull` - Pull remote db \u0026 assets (requires setting up [craft-scripts](https://github.com/nystudio107/craft-scripts/)\n\n## Craft CMS Plugins\n\n1. [CKEditor](https://plugins.craftcms.com/ckeditor)\n1. [CP Field Inspect](https://plugins.craftcms.com/cp-field-inspect)\n1. [Craft Autocomplete](https://github.com/nystudio107/craft-autocomplete)\n1. [Hyper](https://plugins.craftcms.com/hyper)\n1. [Knock Knock](https://plugins.craftcms.com/knock-knock)\n1. [Postmark](https://plugins.craftcms.com/postmark)\n1. [Seomatic](https://nystudio107.com/docs/seomatic/)\n1. [Servd Assets and Helpers](https://github.com/servdhost/craft-asset-storage)\n1. [Vite](https://github.com/nystudio107/craft-vite)\n\n## Tailwind Plugins\n\n1. [Aspect Ratio](https://github.com/tailwindlabs/tailwindcss-aspect-ratio)\n1. [Line Clamp](https://github.com/tailwindlabs/tailwindcss-line-clamp)\n1. [Typography](https://github.com/tailwindlabs/tailwindcss-typography)\n\n## Javascript Libraries\n\n1. [AlpineJS](https://alpinejs.dev/)\n1. [Lazysizes](https://afarkas.github.io/lazysizes/)\n\n## Roadmap\n\n- Continue to improve docs\n- Bugfixes, new features\n\n## Acknowledgements \u0026 Credits\n\nAside from the obvious gratitude owed to the entire team at [Pixel \u0026 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. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonedarnleyroad%2Fcraftcms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonedarnleyroad%2Fcraftcms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonedarnleyroad%2Fcraftcms/lists"}