Get to coding, nerds.
This is a development boilerplate for a project in Craft CMS utilizing Docksal for a local server environment.
This is just a vanilla boilerplate for Craft. In future versions there will be more development environments set up, hopefully utilizing npm and webpack for package management and script bundling respectively.
- (Mac) Must be a 2010 or newer model
- (PC) Your CPU should support hardware VT-x/AMD-V virtualization and it should be enabled in BIOS
- (Mac/Win) Workstation with 4GB is required (8GB recommended)
- (Linux) no minimum requirement (4GB recommended)
- 64-bit OS is required for all platforms
- (Mac) OS X El Capitan 10.11 or newer
- (Mac) VirtualBox prior to version 4.3.30 must NOT be installed
- (Win) Windows 7 or newer
- (Linux) Ubuntu Linux 14.04 or newer (or it's derivatives) with Linux kernel 3.10 or newer
Refer to the environment setup instructions for further steps
See the Docksal documentation for more details
- Install Docksal
curl -fsSL get.docksal.io | sh
- Create and start the vm
fin vm start
- Congratulations!
You are done with the one time environment installation. Now you can [configure your project] to use Docksal or create a new pre-configured project with fin project create.
- Clone the project from the repository into your desired directory.
git clone [this git url]
- cd into the project directory you just cloned
cd [project name]
- Start the Docksal environment outlined in the project's .docksal directory.
fin start or fin up
If this does not work see the Docksal docs for troubleshooting
- In the browser, go to [project name].docksal in order to view your project on the front end.
eg. mycraft.docksal
In order to install Craft, go to mycraft.docksal/admin which should redirect you to the installation page for this project.
- All of the editable files for this project are in the
docrootdirectory for this project. Code away.