viget/craft-site-starter

5.0.0 2024-04-24 22:02 UTC

Requires

• craftcms/cms: ^5.0.0
• vlucas/phpdotenv: ^5.4.0

Requires (Dev)

• craftcms/generator: ^2.0.0
• yiisoft/yii2-shell: ^2.0.3

0BSD

README

This repo is a Composer "project" intended for use with the composer create-project command.

Our starter uses DDEV for local development. Install it before doing any of the following steps.

Create Project

1. Install DDEV

2. Choose a folder for your project and move into it:

   cd /path/to/web/projects
   mkdir my-project
   cd my-project

3. Create The Project If you already have PHP and Composer running on your host machine (your computer, not Docker container or DDEV instance), you can run the following command

   composer create-project viget/craft-site-starter=^5.0.0 ./ --ignore-platform-reqs

   If you'd rather not set up PHP, you can create the project with a desposable Docker image (Thanks nystudio107).

   docker run --rm -it -v "$PWD":/app -v ${COMPOSER_HOME:-$HOME/.composer}:/tmp composer create-project viget/craft-site-starter=^5.0.0 ./ --ignore-platform-reqs

4. Start DDEV & Install Craft

   ddev start
   ddev craft install

5. Run ddev launch to open the project in your browser

Contribute to this starter

Local Dev

Ideally, you should be able to clone this repo and make modifications to plugin & build tool configs with minimal fuss.

Run ddev start and make edits in a feature branch.

See ARCHITECTURE.md for details on technical goals & decisions.