miranj/craft-boilerplate

A Craft CMS 5 starter project by Miranj

Installs: 79

Dependents: 0

Suggesters: 0

Security: 0

Stars: 16

Watchers: 5

Forks: 3

Open Issues: 7

Language:JavaScript

Type:project


README

Miranj

Miranj Craft Boilerplate

A Craft CMS 5 starter project based on Miranj’s project boilerplate (see craft4 or craft3 for the older versions).

Contents

Features

This starter project includes:

Usage

  1. Open your terminal and run the following command:

    composer create-project miranj/craft-boilerplate:dev-dev /path/to/project
    
  2. Replace instances of miranj/craft-boilerplate and boilerplate with the handle of the new project in the following locations:

    • composer.json
    • package.json
    • .ddev/config.yaml
    • config/app.php
    • src/Module.php
    • serverconfigs/envs/production/env.conf
    • serverconfigs/envs/production/setup.conf
    • serverconfigs/envs/staging/env.conf
    • serverconfigs/envs/staging/setup.conf
  3. Replace instances of "Miranj Craft Boilerplate" / and "Boilerplate" with the title of the new project.

  4. Inspect all FIXME comments in the project and take necessary action.

  5. Assign values to all shared environment variables in .env.example.