create-wp-site's Introduction

create-wp-site

create-wp-site is a command line tool to create your local WordPress development with 10up/wp-local-docker.
This tools is inspired by site creation wizard for VVV by brad/vv.

Requirements

NodeJs >= v.6.10.1
Npm >= v.3.10.10
Docker
docker-compose

Install

$ npm install -g create-wp-site

Usage

Once installed globally, create-wp-site should be available from shell.

$ create-wp-site

  Usage: create-wp-site [options] [command]
  
  
    Commands:
  
      info                Show information about this tool
      create              Create new WordPress Site
      addhost [options]   Add hosts to /etc/hosts or C:/Windows/System32/drivers/etc/hosts, need sudo privileges
  
    Options:
  
      -h, --help     output usage information
      -V, --version  output the version number
  
    Examples:
  
      $ create-wp-site <directory-name>

Using Yarn 1.0

$ yarn create wp-site <directory-name>

For more help on specific command, supply -h or --help.

Compile from source

If you want to contribute or want to compile from the source

$ git clone https://github.com/ivankristianto/create-wp-site.git
$ cd create-wp-site
$ npm install && npm run build

Todo(s)

Clone a repository to wp-content
Import SQL File
Option to remove default themes & plugins
Option to add WP_DEBUG and WP_DEBUG_LOG
Option to enable multisite subdirectory / subdomain
Command to compress everything

Note: Pull requests and any feedbacks are always welcome!

Known Issue(s)

This is not tested on Windows platform yet.

Credits

Thanks to contributors

viankakrisna

License

MIT

create-wp-site's People

Contributors

Stargazers

Watchers

create-wp-site's Issues

add a pre-flight check to ensure that all the dependencies needed are there

Steps to Reproduce:

run npx create-wp-site in a machine without docker-compose command available

Expected Behavior:

create-wp-site fails gracefully and point the user to setup docker-compose on their machine it's not available
create-wp-site does not leave the site URL in /etc/hosts

Actual Behavior

create-wp-site still runs and create the project (there are some references of docker-compose is not available, but it still runs and congratulate the user)
the site URL is still in the /etc/hosts

Recommend Projects