https://github.com/studiometa/create-wordpress-project

A generator to kickstart your WordPress project in a few seconds! ⚡
https://github.com/studiometa/create-wordpress-project

composer generator js project scss webpack wordpress

Last synced: 9 months ago
JSON representation

A generator to kickstart your WordPress project in a few seconds! ⚡

• Host: GitHub
• URL: https://github.com/studiometa/create-wordpress-project
• Owner: studiometa
• License: mit
• Archived: true
• Created: 2019-08-28T09:29:33.000Z (almost 7 years ago)
• Default Branch: develop
• Last Pushed: 2022-09-21T12:51:35.000Z (over 3 years ago)
• Last Synced: 2024-10-02T05:23:31.418Z (over 1 year ago)
• Topics: composer, generator, js, project, scss, webpack, wordpress
• Language: PHP
• Homepage:
• Size: 1.82 MB
• Stars: 6
• Watchers: 13
• Forks: 3
• Open Issues: 13
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Create WordPress Project

[![NPM Version](https://img.shields.io/npm/v/@studiometa/create-wordpress-project.svg?style=flat-square)](https://www.npmjs.com/package/@studiometa/create-wordpress-project)

[![Dependency Status](https://img.shields.io/david/studiometa/create-wordpress-project.svg?label=deps&style=flat-square)](https://david-dm.org/studiometa/create-wordpress-project)

[![devDependency Status](https://img.shields.io/david/dev/studiometa/create-wordpress-project.svg?label=devDeps&style=flat-square)](https://david-dm.org/studiometa/create-wordpress-project?type=dev)

> A generator to kickstart your WordPress project in a few seconds! ⚡ 

## Usage

### Install

Run the following command to bootstrap a WordPress project using Studio Meta's tools and workflows:

```

npx @studiometa/create-wordpress-project project-name

```

Follow the prompt steps to complete the project creation.

### To get started

- Go to your project folder

- Create a `.env` file based on `.env.example`

- Generate the salts `bin/get-wp-salts.sh` and put them in the `.env` file

- Install composer dependencies `composer install`

- Create a database with WPCLI `./vendor/bin/wp db create` (this command is using the variables filled in `.env` file)

- Install WordPress with WPCLI `./vendor/bin/wp core install --url="" --admin_user="" --admin_email="" --title="`

- Install NPM dependencies `npm i`

- Have fun !

## Documentation

This tool will generate a WordPress project managed by Composer and Webpack. See the [readme.md](./template#readme) file in the template folder for a more detailed documentation.

## Contributing

This project's branches are managed with [Git Flow](https://github.com/petervanderdoes/gitflow-avh), every feature branch must be merged into develop via a pull request.

## TODO

- [ ] Test if Wordpress loads plugins in a subfolder of `wp-content/plugins/`

- [ ] Test if Wordpress loads mu-plugins in a subfolder of `wp-content/mu-plugins/`

- [ ] Test if Wordpress loads themes in a subfolder of `wp-content/themes/`

- [ ] Use a child theme