This is a WordPress starter project that includes a basic custom theme, including some essential custom components, and a project setup designed for fast local setup and development.
auth.json
file in the project root directory, which can be downloaded from the ACF Website.To begin using this on a new project, simply call the following command from the root of your project:
composer create-project viget/wordpress-site-starter .
Follow the prompts to set up your project with the desired information. You will be asked:
My Project
): This will serve as the name of the WordPress Theme.my-project
): This will be used as the directory name for the theme as well as the local DDEV site name.my-project
): This will be used for internationalization and localization and defaults to the project slug.MyProject
): This is referenced in the PhpDoc blocks and default project namespace. It defaults to the project name.my_project_
): This is used to prefix all custom theme functions and defaults to the project slug.Following the series of prompts, the project will be set up with the following:
auth.json
file is present in the project root, ACF Pro will be installed.package.json
Dependencies: All necessary script and style build dependencies for the theme will be installed and initialized.After the setup is complete, it is recommended to perform your initial commit and push to your project repository.
The following command will create a directory (project-name
) and run composer create-project
using your local repository as the source. Be sure to replace the path with the correct path to your local repository.
Also, in packages.json
, you can change the name of the branch from main
to use your current working branch.
Note: Be sure to update the paths in packages.json
as well as the command below to point to the location of your local repository. ~/
will not work, you must use the full path.
mkdir project-name && cd project-name && composer create-project --repository-url="/root/path/not/relative/path/to/wordpress-site-starter/packages.json" viget/wordpress-site-starter . --stability=dev --remove-vcs --no-install
You can quickly remove the project by using:
ddev delete project-name -O -y && cd ../ && rm -rf project-name
vendor
directory after create-project is complete.packages.json
file.composer.lock
packages.json
file.