https://github.com/wp-digital/wp-project-skeleton

https://github.com/wp-digital/wp-project-skeleton

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wp-digital/wp-project-skeleton
• Owner: wp-digital
• Created: 2019-10-15T13:24:39.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-08-31T19:52:40.000Z (over 1 year ago)
• Last Synced: 2024-07-08T22:23:22.454Z (7 months ago)
• Language: PHP
• Size: 262 KB
• Stars: 4
• Watchers: 13
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# WordPress Project Skeleton

### Description

[SMFB Dinamo](https://www.smfb-dinamo.com/) starter code for a WordPress project.

### Install

There are few possible options to use this skeleton:

- Create new project with [Composer](https://getcomposer.org/):

  ```

  composer create-project wp-digital/wp-project-skeleton

  ```

- Create new project on [GitHub](https://github.com/) from

  [this template](https://github.com/wp-digital/wp-project-skeleton).

- Alternative way is to clone this repo:

  ```

  git clone [email protected]:wp-digital/wp-project-skeleton.git 

  ```

Find `@TODO: ...` in code and replace with needed settings.

### Documentation

#### Install plugins, mu-plugins, PHP packages

Manage dependencies with Composer. To install e.g. plugins use:

```

composer require innocode-digital/wp-hybrid-lazy-loading

composer require wpackagist-plugin/wp-crontrol

```

#### Update WordPress core, plugins, mu-plugins, PHP packages

All updates should be done through Composer. To update e.g.

WordPress core use:

```

composer update johnpbloch/wordpress

```

To update all dependencies (core, plugins, PHP packages):

```

composer update

```

Normally project should be initialized with new `.env` file after `create-project` command

but if it was not created or other method was used to create project

then it's possible to initialize `.env` with next command:

```

composer run-script wp-init

```

If you want to install some theme as dependency then remember

to add it to `.gitignore`.

#### Cron

By default, WordPress cron is disabled, but it's possible to enable it through environment variable:

````

USE_WP_CRON=true

````

There is a possibility to use server-side cron. It's needed to do next steps to make it run:

1. Make [script](./bin/run-wp-cron) executable: `chmod +x ./bin/run-wp-cron`

2. Test script: `./bin/run-wp-cron`

3. Set server-side cron e.g. with per each 5 minutes: `*/5 * * * * /path/to/bin/run-wp-cron`

### Caveats

**Install premium extensions from metabox.io**

See documentation [metabox.io](https://docs.metabox.io/extensions/composer/) on how to do it in general.

Keep in mind that storing of the API Key in project `composer.json` is not a good idea, since

it could be situation that project will be taken by someone else, so the API Key may be accidentally

shared. To add private source to `repositories`, you can add it in global config with the following command

`composer config repositories.metabox\.io composer https://packages.metabox.io/ --global` or edit

`$HOME/.composer/config.json` manually:

```

{

    "config": {},

    "repositories": {

        "metabox.io": {

            "type": "composer",

            "url": "https://packages.metabox.io/"

        }

    }

}

```

Then it should be possible to add extensions to project:

```

composer require meta-box/meta-box-group:dev-master

```