for developers
Welcome
Boilerplates
Getting StartedCraft CMSGetting startedSettingsPluginsCustom modulesLocal developmentPost InstallationNext.JS
Code Linting
Github Actions
Private Registry
Styled
🔒  Local Setup
🔒  Server Setup
🔒  Code Challenge

Craft CMS

Visit our server setup guide to setup a live site. Note: this guide is private.

Getting started

Setup a new repository using the wild-craft boilerplate.

Settings

Following settings and fields are enabled by default.

GraphQL

  • GraphQL API has been enabled and can be reached at /api.

Fields

  • A couple of fields have been added mostly to demonstrate their functionallity. Feel free to delete or edit them.

Sections

  • A basic page section has been added. Feel free to delete or edit it.
  • A basic global SEO section has been added. Feel free to delete or edit it.

Volumes

  • A default asset volume has been addded with a S3 storage provider that is connected to an imgIX source. Both have been created during the initial server setup.

Plugins

Following plugins are enabled by default.

Amazon S3

  • Amazon S3 integration for Craft CMS.
  • This plugin requires a S3 bucket with read-write permissions. This is usually created during the initial server setup.
  • Documentation

Colorit

  • A slick color picker fieldtype plugin for the Craft CMS 3 control panel.
  • Documentation

Field Manager

  • Manage your fields and field groups with ease with simple field or group cloning and quicker overall management.
  • Documentation

Neo

  • A Craft field type for selecting links.
  • We are using the ^v2.0.0-rc.1 version for full GraphQL support.
  • Documentation

Custom modules

Image Color Palette module

This Module adds the domainant colors in an image to an image at the point of upload. It is powered by Imgix.

How to use

  • Create a field called Color Palette with a handle palette as a Plain Text field
  • Go to Assets, use the default Volume or create a new Volume called default
  • In the Volume , add the Color Palette Field to the field layout and click Save

NB:

  • Image Color Palette Module expects the field handle to be palette but it can be configured in modules > ImageColorPalette.php by changing the ASSET_FIELD_HANDLE value
  • Similarly, Image Color Palette Module expects the Volume handle to be default but it can be configured in modules > ImageColorPalette.phpby changing the ASSET_VOLUME_HANDLE value

Local development

Lando

Lando is a simple and free utility to manage isolated local servers. Visit the official Lando documentation for general usage.

  • Install the lando package and adjust .lando.yml config to your liking.
  • Run lando start. Note: on first run this might take a little while, because dependencies need to be downloaded and installed.
  • Run lando composer install to install all dependencies.
  • Run lando info to get the configuration file for the new lando instance.
  • Copy .env.example to .env and edit the database and URL information using values you obtained from lando info.
  • Run lando php craft install to install Craft.
  • Run lando php craft project-config/apply to apply default settings.
  • Visit http://lando_url:lando_port/admin

MAMP

  • Install MAMP
  • Install Composer - brew install composer
  • Install PHP
  • Open MAMP, Go to Preferences > Server > Document root and choose the web directory in this project as the document root, Click on OK
  • Open PhpMyAdmin and create a new database called wild-craft
  • Update database credentials in your .env file
  • Go to your project, and then install dependencies composer install
  • Run php craft install
  • Run php craft project-config/apply
  • Visit http://localhost:8888/admin/

Laravel Valet

  • Install PHP (Optional Step)
  • Install Composer - brew install composer
  • Add Composer to our $PATH - echo 'export PATH="$PATH:~/.composer/vendor/bin"' >> ~/.bashrc
  • Download Laravel Valet - composer global require laravel/valet
  • Install Laravel Valet - valet install
  • Install MySQL and start mysql brew install mysql brew services start mysql
  • Update database credentials in .env
  • Install dependencies composer install
  • Run valet link, the website will be available at wild-craft.test
  • Add http://wild-craft.test to BE_SITE_URL in .env
  • Run php craft install
  • Run php craft project-config/apply
  • Visit http://wild-craft.test/admin

Post Installation

  • Once Craft has been installed locally, you will want to upgrade it to a PRO edition. Note: this license may remain a trial during development and will later be added to a Craft ID account including all paid plugin licenses.