@10up/create-10up

10up Project Scaffold

The 10up Project Scaffold is a command line tool to quickly initialize a starter theme or plugin for your new project. It adheres to all 10up's best practice coding standards and has been reviewed for security, performance, and scalability. This project is aimed specifically at the work that 10up does, but we welcome all community contributions.

Contributing

If you have an update for the theme or plugin that is generated, please submit those issues or pull requests with the associated repository:

View the theme repository

View the plugin repository

Set Up from Github

1. Clone the repository locally
2. Run cd project-scaffold
3. Run npm install
4. Run npm link to make the create-10up command global

Setup from npmjs.com

npm install @10up/create-10up -g or npx @10up/create-10up [type] [name]

Project Types

• theme
• plugin
• component

Example Usage with local installation

cd <your-project-directory>

create-10up theme human-theme-name

create-10up plugin human-plugin-name

create-10up component human-component-name

Example Usage without local installation

npx @10up/create-10up theme human-theme-name

npx @10up/create-10up plugin human-plugin-name

npx @10up/create-10up component human-component-name

Updating this tool

create-10up is in active development. To get the latest, navigate to this folder in your home directory (or wherever else you have it installed) and git pull.

Learn more about the packages used with this project

• Chalk
• Commander
• FS extra
• Git clone
• Path
• Replace in file

Support Level

Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.

Like what you see?