Giter Club home page Giter Club logo

kapow-setup's Introduction

Kapow! Setup

The setup script for the Kapow! boilerplate for bespoke WordPress site development.

Requirements

You will need the following installed on your system before attempting to set-up a Kapow! project using this guide.

It is also recommended that you are running WP CLI version 0.24.x or greater to avoid a fatal error when running the wp core install... command which prevents the core WP tables from being added to the database. Run wp cli update to upgrade to the latest stable release.

Installation

  1. Create a new folder in your Vagrant web root e.g. Vagrant/www/my-project.

  2. Download the kapow.sh script from this repo and move it to the folder you just created or grab it directly via the terminal using the commands below and:

curl -O https://raw.githubusercontent.com/mkdo/kapow-setup/master/kapow-setup/kapow.sh

wget https://raw.githubusercontent.com/mkdo/kapow-setup/master/kapow-setup/kapow.sh

  1. Make the script executable via the command line using chmod a+x kapow.sh.

  2. Run the script with ./kapow.sh and up to five additional parameters to facilitate string replacement across the entire new Kapow! project you've created.

TIP: Create an alias called getkapow on your machine that invokes one of the above commands to fetch Kapow! before making it executable. Useful if you use Kapow! as much as we do!

Kapow! Setup Parameters

The parameters must be added in the following order:

  • Project Slug e.g. avengers-initiative *
  • Project Nice Name e.g "Avengers Initiative"
  • Author Name e.g. "Director Fury"
  • Author Email e.g. [email protected]
  • Author Website e.g. www.avengers.com

NB: The project slug will be used for the theme folder name, theme textdomain, code namespace and database name.

An example using all of the above would look like this:

./kapow.sh the-avengers "The Avengers" "Nick Fury" [email protected] www.avengers.com

NB: Strings containing spaces must be encapsulated in double quotes.

kapow-setup's People

Contributors

mattwatsoncodes avatar

Watchers

James Cloos avatar

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.