A modern, best-practice filled base for bespoke WordPress site development.
NOTE: This readme is automatically deleted when the setup.sh script completes.
You will need the following installed on your system before attempting to set-up a MKDO Base based project using this guide:
As this script leverages the GitHub API for repository creation, you will need to take some additional steps before being able to use it to scaffold a new project instance, due to the additional authentication required. If you do not have 2FA enabled on your GitHub account, please do so here ASAP.
- Head over to https://github.com/settings/tokens.
- Generate a new token, giving it
repo
privileges, and name it so that you know it relates to MKDO Base - Copy the token before moving away from this page.
- Create a new file
~/.mkdobase_token
on your machine. - Paste the token into this file and save.
This script will look for ~/.mkdobase_token
before doing anything else, and will abort if the token is not present. This file should only contain the personal access token you copied from Github, and nothing else.
-
Navigate to your projects root e.g.
~/Valet
. -
Grab the script directly via the terminal using the command below:
curl -O https://raw.githubusercontent.com/mkdo/mkdo-base/master/setup.sh
...or...
wget https://raw.githubusercontent.com/mkdo/mkdo-base/master/setup.sh
-
Make the
setup.sh
script executable via the command line usingchmod a+x setup.sh
. -
Run the script with
./setup.sh
and the two additional parameters to facilitate string replacement.
TIP: Create an alias called getbase
on your machine that invokes the curl/wget commands above to fetch the MKDO Base before making it executable.
- Answer questions as you are prompted, while sipping your beverage of choice.
The parameters must be added in the following order:
- Project Slug e.g.
stark-industries
* - Project Nice Name e.g
"Stark Industries"
NB: The project slug will be used for the theme folder name and database name.
An example using all of the above would look like this:
./setup.sh stark-industries "Stark Industries"