Skip to content

Craft 3 project boilerplate to start a project. Integrates with pips.css

Notifications You must be signed in to change notification settings

fruitstudios/craft-setup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Craft Setup

Basic project structure for a Craft 3 set up. Includes some base macros, scss/js folder setup, and gulp workflow.

  • Templates structure, includes directory structure for messages, notifications, layouts and macros.
  • Essential Macros, fields, icons etc.
  • Front-end gulp workflow for css/js & images.

Setup Steps

  • Install Craft

  • Install Multi Environment Config and configure - Github

    • Copy config/db.php, config/general.php & config/volumes.php to your project's config/ folder
    • Copy web/index.php to your project's web/ folder
    • Copy the script craft to your project's root (this is the console bootstrap file for Craft)
    • Copy example.env.php to your project's root folder, then duplicate it, and rename the copy .env.php
    • Edit the .env.php file, replacing instances of REPLACE_ME with your appropriate settings

    Environments to set up: local, dev, staging and live

  • Install Craft Scripts and configure - Github

    • Copy the scripts directory into the root directory of your Craft CMS project
    • In the scripts directory, duplicate the craft3-example.env.sh file, and rename it to .env.sh.
    • Then open up the .env.sh file in your editor, replace REPLACE_ME with the appropriate settings.
  • Move the src folder from this repo to the project root

  • Copy the config folder contents to project repo

  • Move templates to the project root

  • Add the .htaccess file from this repo to the web folder

  • Copy package.json gulpfile.js and .gitignore to project root

  • Run $ npm install

  • Add test domain via Valet valet link domain and secure valet secure domain

  • Set domains in config/patrol.php

  • Add the local domain to the package.json

  • Run ./node_modules/.bin/tailwind init

  • Install Patrol composer require selvinortiz/patrol

  • Install Linkit composer require fruitstudios/linkit

  • Install Field Manager Plugin composer require verbb/field-manager

  • Install AWS S3 Plugin composer require craftcms/aws-s3

  • Install Redactor Plugin composer require craftcms/redactor

  • Install Postmark Plugin composer require flipboxfactory/craft-postmark

  • Install Preparse Plugin composer require aelvan/preparse-field

  • Install Position Plugin composer require rias/craft-position-fieldtype

  • Install Typogrify Plugin composer require nystudio107/craft-typogrify

  • Install Relabel Plugin composer require anubarak/craft-relabel

  • Install Craft Queue Manager Plugin composer require lukeyouell/craft-queue-manager

  • Install Async (Background) Queue Plugin composer require ostark/craft-async-queue

    • composer require selvinortiz/patrol && composer require fruitstudios/linkit && composer require verbb/field-manager && composer require craftcms/aws-s3 && composer require craftcms/redactor && composer require flipboxfactory/craft-postmark && composer require aelvan/preparse-field && composer require rias/craft-position-fieldtype && composer require nystudio107/craft-typogrify && composer require anubarak/craft-relabel && composer require lukeyouell/craft-queue-manager && composer require ostark/craft-async-queue
  • Import fields from fields_to_import.json file

  • Set up global sets globalSettings, globalSeo

Acknowledgments

About

Craft 3 project boilerplate to start a project. Integrates with pips.css

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published