https://github.com/mickaelzhang/wp-boilerplate
Boilerplate for WordPress project
https://github.com/mickaelzhang/wp-boilerplate
boilerplate wordpress
Last synced: about 1 year ago
JSON representation
Boilerplate for WordPress project
- Host: GitHub
- URL: https://github.com/mickaelzhang/wp-boilerplate
- Owner: mickaelzhang
- Created: 2016-10-20T14:44:29.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-01T21:10:18.000Z (almost 9 years ago)
- Last Synced: 2025-03-28T14:21:28.193Z (over 1 year ago)
- Topics: boilerplate, wordpress
- Language: PHP
- Homepage:
- Size: 274 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wp-boilerplate
This boilerplate was built for my own WordPress project, feel free to use it and change it as your own convenience. The structure is heavily inspired by [Bedrock](https://github.com/roots/bedrock).
## What does the boilerplate contain
* [WordPress Packagist](https://wpackagist.org)
* Gulp tasks
* [Timber](https://upstatement.com/timber/)
## Requirement
To run this boilerplate, you need :
* At least `PHP 5.6`
* `composer` installed
* `yarn` or `npm` installed
## Installation
First, install all the dependencies by running :
```
composer install
yarn install
```
And then, run :
```
project:setup
```
It will setup a `.env` file, it is where you put sensitive information such as database login.
## Scripts
The boilerplate contain some script that help you during the development process.
* `composer project:setup` : Use it at the initial setup of the project, it will add a .env file
* `composer env:regenerate` : Regerate the .env file
* `yarn run start` : Start the dev environment
* `yarn run build` : Build all assets (css, js, font, image)
* `yarn run images` : Copy image to the `dist` directory