• DocumentationDocs

Set Up Project

├── 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
└── .env.in                  # Environment variables
└── .gitignore               # Git ignored files
└── .editorconfig            # Editor code styles
└── .stylelintrc             # Stylelint configuration
└── docker-compose.yml       # Docker configuration
└── Dockerfile.in            # Docker file
└── 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

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

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.

Install dependencies

npm install

Build environment

On the first run, WordPressify needs to set up a local server and a database for the new WordPress installation, we do this once by running the command:

npm run env:build

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

Change template name

At this point WordPressify is installed and ready to be used for the first time. 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 dev

You are ready to go! Happy coding! 🤓

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

Bring down environment

To stop the WordPressify server and database for the project run:

npm run env:stop

Rebuild environment

To rebuild the WordPressify project environment run:

npm run env:rebuild

WordPress Plugins

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


Production Template

To generate your distribution files run the command:

npm run prod

The template will be saved as a zip file in:

Installing Node.js and DockerCSS, PostCSS and Sass

Follow the creator

Join the community