Giter Site home page Giter Site logo

craftcms-starter's Introduction

craftcms-starter

Overview

craftcms-starter is a project starter tool designed to streamline the setup process for a Craft CMS project with a modern development environment. This tool integrates a Makefile, Docker, DDEV, Craft CMS, ViteJS, and Tailwind CSS to provide a seamless setup experience for your team.

The git repository for the tool can be found at https://github.com/dative/craftcms-starter.

Notable Features

Prerequisites

Before using the craftcms-starter tool, make sure you have the following installed:

Getting Started

Commands

To set up a new project, run the following command in your terminal:

make install

This command executes three individual tasks sequentially: install-ddev, install-buildchain, and install-cms. You can also run these tasks individually if needed.

install-ddev

This task sets up the DDEV environment for the project. To run this task individually, use:

make install-ddev

install-buildchain

This task sets up the build chain, which includes ViteJS and Tailwind CSS. To run this task individually, use:

make install-buildchain

install-cms

This task sets up the Craft CMS environment, including the necessary configuration files and templates. To run this task individually, use:

make install-cms

Template System

The craftcms-starter comes with an opinionated base template system that is designed to get you up and running quickly. You can use the templates as-is, or you can customize them to your project needs.

To learn more about the template system, see the Template System section below.

Customization

You can customize the setup process by modifying the Makefile variables. Uncomment and set the following variables to override the default values:

  • CRAFT_PATH: The path where the Craft CMS files will be located.
  • DDEV_PATH: The path where the DDEV files will be located.
  • SRC_PATH: The path where the source files (CSS, JS, and others) will be located.
  • DEFAULT_SITE_NAME: The default name for the site.
  • ADMIN_USERNAME: The default admin username.

For example, to change the default Craft CMS path to my-cms, you can update the Makefile as follows:

CRAFT_PATH := my-cms

After updating the variables, run the setup-project command to apply the changes.

Testing

git submodule init git submodule update --init

https://github.com/ddev/github-action-setup-ddev

Roadmap

  • Add support for Windows WSL

Contributing

Coming Soon

craftcms-starter's People

Contributors

diegocosta-dev avatar

Watchers

Chris OBrien avatar Rodrigo Passos avatar  avatar

Forkers

webrgp

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.