• DocumentationDocs

Set Up Project

Make sure Docker is running, otherwise the process will fail.

├── build/                   # Build files
├── config/                  # Nginx & PHP configs
├── dist/                    # Distribution files
├── src/                     # Source files
│   ├── assets/              # Assets directory
│       ├── css/             # CSS files
│       ├── fonts/           # Fonts directory
│       ├── img/             # Image directory
│       ├── js/              # JavaScript files
│   ├── plugins/             # WordPress plugins
│   ├── theme/               # PHP Template files
└── .babelrc                 # Babel configuration
└── .dockerignore            # Docker ignore file
└── .editorconfig            # Editor code styles
└── .env_example             # Environment variables
└── .gitignore               # Git ignored files
└── .stylelintrc             # Stylelint configuration
└── docker-compose.yml       # Docker files
└── Dockerfile-nodejs        # Docker files
└── Dockerfile-wordpress     # Docker files
└── gulpfile.js              # Gulp configuration
└── LICENSE                  # License agreements
└── package-lock.json        # Packages lock file
└── package.json             # Node.js packages
└── README.md                # You are reading this
File structure

Install WordPressify from NPM

To install WordPressify create a directory for the new WordPress website and from there run the command to generate the file structure:

npx wordpressify

That’s it 🍾 easy as that. Now start the development workflow: Start workflow


Install WordPressify from Repository

To install WordPressify you need to clone the repository from GitHub:

git clone https://github.com/luangjokaj/wordpressify

This will clone the repository on your local machine. Navigate to the newly created directory.

Replace the file: ./package.json with ./installer/package.json and continue with the dependency installation.


Change template name

Before starting, open gulpfile.js and edit your template name:

/* -------------------------------------------------------------------------------------------------
Theme Name
------------------------------------------------------------------------------------------------- */
const themeName = 'wordpressify';
//--------------------------------------------------------------------------------------------------

Start workflow

To start the development server run the command:

npm run start

Alternatively if you don't have NodeJS installed locally, use Docker commands:

docker compose up

You are ready to go! Happy coding! 🤓

Make sure Docker is running, otherwise this ☝ command will fail.


Rebuild environment

To rebuild the WordPressify environment, with a fresh installation and a clean database run:

npm run rebuild

Alternatively if you don't have NodeJS installed locally, use Docker commands:

docker compose down -v && docker compose build

WordPress Plugins

If you want to add or build WordPress plugins, you can do that from the directory:

src/plugins

Production Template

To generate your distribution files run the command:

npm run export

Alternatively if you don't have NodeJS installed locally, use Docker commands:

docker compose run --rm nodejs npm run prod

The template will be saved as a zip file in:

dist/wordpressify.zip
Installing Node.js and DockerCSS, PostCSS and Sass

Follow the creator

Join the community