statikbe/craft

There is no license information available for the latest version (3.4.0) of this package.

Craft CMS starter package, by Statik.be

Installs: 277

Dependents: 0

Suggesters: 0

Security: 0

Stars: 17

Watchers: 8

Forks: 3

Open Issues: 10

Language:Twig

Type:project


README

This a scaffolding package for Craft CMS, by Statik.be. We use this internally to start new projects.

Assumptions made

We assume a couple of things

🛠 Usage

Use the following command to set up a new project:

composer create-project statikbe/craft PATH

➡️ A Craft CMS project will be created. Next Craft asks to start the set-up:

   ______ .______          ___       _______ .___________.
  /      ||   _  \        /   \     |   ____||           |
 |  ,----'|  |_)  |      /  ^  \    |  |__   `---|  |----`
 |  |     |      /      /  /_\  \   |   __|      |  |
 |  `----.|  |\  \----./  _____  \  |  |         |  |
  \______|| _| `._____/__/     \__\ |__|         |__|

     A       N   E   W       I   N   S   T   A   L   L
               ______ .___  ___.      _______.
              /      ||   \/   |     /       |
             |  ,----'|  \  /  |    |   (----`
             |  |     |  |\/|  |     \   \
             |  `----.|  |  |  | .----)   |
              \______||__|  |__| |_______/


Generating an application ID ... done
Generating a security key ... done

Welcome to Craft CMS!

Are you ready to begin the setup? (yes|no) [yes]

➡️ The next questions will be asked:

  • Which database driver are you using? (mysql or pgsql)
  • Database server name or IP address [127.0.0.1]
  • Database port [3306]
  • Database username [root]
  • Database password
  • Database name
  • Database table prefix

➡️ If the database is connected Craft can be installed

  • Install Craft now? [yes]
  • Email
  • Password
  • Confirm
  • Site name [NL]
  • Site URL [@baseUrl/nl]
  • Site language [nl-BE]

➡️ Craft is installed, the plugins are installed and the existing project config is applied! 🚀

Now we're ready to initiate the Statik set-up:

cd PATH

./craft statik/setup

➡️ This will give you the following options/ask you the following questions:

       _______.___________.    ___   .___________.__   __  ___
        /       |           |   /   \  |           |  | |  |/  /
       |   (----`---|  |----`  /  ^  \ `---|  |----|  | |  '  /
        \   \       |  |      /  /_\  \    |  |    |  | |    <
    .----)   |      |  |     /  _____  \   |  |    |  | |  .  \
    |_______/       |__|    /__/     \__\  |__|    |__| |__|\__\

       A     N  E  W     C  R  A  F  T     P  R  O  J  E  C  T
  • Enter a new system name
  • Do you want to remove the frontend account flow in Craft?

If you continue the next sections will be removed: confirmAccount, editPassword, editProfile, forgotPassword, forgotPasswordConfirmation, login, profile, register, registrationCompleted, setPassword, setPasswordConfirmation

  • Do you want to use Postmark for email transport? (yes|no)
    • Enter a Postmark API key
  • Enter an emailaddress to use for testing on staging environments
  • Do you want to set up a git repo for this project? (yes|no)
    • Add a remote?
  • Do you want to initialize git-flow? (yes|no)

➡️ The installation is ready!

🎨 Frontend Setup

We use tailwindscss and webpack

  • webpack.config.js
  • tailwind.config.js

Getting started

yarn install

Afterwards you can build using

yarn dev

or

yarn watch

CSS and Javascript

tailoff/css and tailoff/js

Favicon Add an svg in tailoff/img/ called favicon.svg and run

yarn favicon

Icons

⚙️ Development

To work on this repo you can clone it like you would a regular project:


git clone git@github.com:statikbe/craft.git craft

⭐️ Features & support

We'd love the hear your suggestions and review your pull requests, but keep in mind that is repo is for internal projects first.