Skip to content

WordPress boilerplate theme built with Gutenberg and Edje Library

Notifications You must be signed in to change notification settings

hrsetyono/edje-wp-theme

Repository files navigation

Edje WordPress Theme

A WordPress starter theme for developer using Timber Library and ACF Pro. Also supports WooCommerce.

Stylesheet is compiled with Node Sass and using Edje Framework. Visit that link to know how to compile Sass.

REQUIREMENTS

TABLE OF CONTENTS

  1. Installation
  2. Useful Links

Installation

MANUAL

  1. Copy this repo to your WordPress theme directory
  2. Download the required plugins, they are: Timber, ACF Pro (Paid), and Edje WP Library

WITH COMPOSER

Available in Packagist under the name pixelstudio/edje-wp-theme.

This is our workflow for starting new project. This steps will also download WP Core files and other required plugins.

  1. Create empty directory then create new file named composer.json. Put this code below inside it:

    {
      "name": "pixelstudio/new-site",
      "description": "Run the command `composer update` to download all plugins and themes.",
      "authors": [
        { "name": "Pixel Studio", "email": "[email protected]", "homepage": "https://pixelstudio.id" }
      ],
      "require": {
        "pixelstudio/wordpress": "~5.2",
        "pixelstudio/edje-wp-theme": "~5.0",
        "pixelstudio/advanced-custom-fields": "~5.8",
        "pixelstudio/edje-wp-library": "~2.0",
        "pixelstudio/wp-sync-db": "~1.6",
        "pixelstudio/wp-sync-media": "~1.1",
    
        "wpackagist-plugin/jetpack": "*",
        "wpackagist-plugin/timber-library": "*",
        "wpackagist-plugin/autodescription": "*",
        "wpackagist-plugin/contact-form-7": "*",
        "wpackagist-theme/twentynineteen": "*"
      },
      "require-dev": {},
      "suggest": {
        "pixelstudio/edje-wc-library": "~2.0",
        "wpackagist-plugin/woocommerce": "*",
        "wpackagist-theme/storefront": "*"
      },
      "repositories":[
        { "type": "composer", "url":"https://wpackagist.org" }
      ],
      "autoload": { "psr-0": { "Acme": "src/" } }
    }
    
  2. If you want WooCommerce site, add the value of suggest to require.

  3. Run the command composer update in that directory.

  4. Done! You will find the WP Core files inside wp-core/ directory. Cut it to root.

  5. Recommended: Rename edje-wp-theme so it won't be overriden the next time you run composer update. Also remove pixelstudio/wordpress in JSON file after first installation.

Useful Links

  1. What is Edje Sass?
  2. What is Edje WordPress Library?
  3. What is Edje WooCommerce Library?
  4. How to compile Sass files?
  5. How to debug with mobile browser?

About

WordPress boilerplate theme built with Gutenberg and Edje Library

Resources

Stars

Watchers

Forks

Packages

No packages published