Template: WordPress

A WordPress template that uses Docker for running locally.

Table of Contents

• 1. Overview
  • 1.1. Project Structure
• 2. Development
  • 2.1. Requirements
  • 2.2. Run Locally
• 3. Appendix
  • 3.1. Useful Commands
• 4. How to Contribute
• 5. License

🗂️ 1. Overview

1.1. Project structure

This repo uses a pseudo-monorepo structure:

.
├─ .database/                       <-- When run, this will be populated with the MySQL files at /var/lib/mysql.
│   └── ...
├─ .public/                         <-- When run, this will be populated with the WordPress files at /var/www/html.
│   └── ...
├── .editorconfig                   <-- Editor configuration file.
├── commitlint.config.mjs           <-- Commitlint configuration.
├── compose.yaml                    <-- Docker Compose configuration.
├── CONTRIBUTING.md                 <-- Guidelines for contributing to the project.
├── LICENSE
├── Makefile                        <-- Scripts.
├── README.md
└── ...

^{Back to top ^}

🛠 2. Development

2.1. Requirements

• Docker and Docker Compose
• Make

^{Back to top ^}

2.2. Run Locally

With Docker and Docker Compose installed, you can run the following command:

make start

This will start the containers and populate the .database and .public directories with the WordPress and MySQL files respectively.

^{Back to top ^}

📑 3. Appendix

3.1. Useful Commands

Command	Description
make install	Installs development tools such as commitlint, and sets up git hooks.
make start	Starts the Docker containers for WordPress and the MySQL database.

^{Back to top ^}

👏 4. How to Contribute

Please read the contributing guide to learn about the development process.

^{Back to top ^}

📄 5. License

Please refer to the LICENSE file.

^{Back to top ^}