1. Installation

Requirements

• PHP >= 7.0
• Composer - Install | Download

Installation

Currently we have 2 different versions of our starter. They have different list of default plugins to be installed.

• v2.* tags uses ACF (Advanced Custom Fields) as main plugin for custom fields and you can switch to PRO to use it for Theme Options.
• v1.* tags uses JCF (Just Custom Fields) as main plugin for custom fields and Titan Framework plugin for building a Theme Options page.

You can specify which version you want to use in a first step.

1. Create a project based on Starter in some folder:

   latest pack with ACF:

   composer create-project justcoded/wordpress-starter:2.* your-project-folder-name

   or old pack with JCF/Titan Framework/Page Builder examples:

   composer create-project justcoded/wordpress-starter:1.* your-project-folder-name

2. Set important environment variables in .env file:

• DB_NAME - Database name
• DB_USER - Database user
• DB_PASSWORD - Database password
• DB_HOST - Database host
• WP_HOME - Full URL to WordPress home (http://example.com)

You can read more about available variables on Environment variables Page.

3. Run WordPress install as usual by accessing your site at http://example.com/

4. Enjoy!

ACF vs ACF PRO

By default starter has special configuration to connect your ACF PRO licence quickly.

To do this you need to open your composer.json and update URL for ACF PRO zip and package version:

{
  // ...
  "require": {
    // ...
-    "acf/advanced-custom-fields-pro": "dev-master"
+    "acf/advanced-custom-fields-pro": "dev-5.6pro"
  },
  // ...
  "repositories": [
    // ...
    {
      "type": "package",
      "package": {
        "name": "acf/advanced-custom-fields-pro",
        "type": "wordpress-muplugin",
-        "version": "dev-master",
+        "version": "dev-5.6pro",
        "dist": {
          "type": "zip",
-          "url": "https://downloads.wordpress.org/plugin/advanced-custom-fields.5.7.6.zip"
+          "url": "https://connect.advancedcustomfields.com/index.php?a=download&p=pro&k=YOUR-LICENSE-KEY"
        }
      }
    }
  ],

In case you will use a free version of ACF plugin we recommend to replace require statement with usual wpackagist dependency like this:

  "require": {
    // ...
-     "acf/advanced-custom-fields-pro": "dev-5.6pro"
+     "wpackagist-plugin/advanced-custom-fields": "*",
  },

Don't forget to run composer update after editing of composer.json file.

Theme boilerplate

If you want to use our Theme Boilerplate for your project you can generate a new theme inside /wp-content/themes folder with simple command:

composer wp:theme -- <folder-name> [-t="My Theme"] [-ns="ClientName"] [-dir="wp-content/themes"] [-s, silent install]

If you forgot the syntax of the command or want to know more about command options you can just call command without any options to get command help:

composer wp:theme

---

Next: Deploying