ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / sparklp6 / public_html / website_356c8563 / wp-content / plugins / bluehost-wordpress-plugin / docs

# Getting started

## Prerequisites

- **Node.js** ≥ 20, **npm** ≥ 10 (see `package.json` engines).
- **PHP** 7.4+ (local dev often uses 8.1 via wp-env).
- **Composer** for PHP dependencies.
- **Git** for the repository.

## Install dependencies

From the plugin root:

```bash
npm install --legacy-peer-deps
composer install
```

Use `--legacy-peer-deps` for npm to satisfy the current dependency tree.

## First run (development)

1. Install dependencies (above).
2. Start the dev server (with hot reload):

```bash
   npm run start
   ```

3. Build output goes to `build/<version>/` (e.g. `build/4.14.1/`). The plugin loads assets from this path at runtime.

For a full local WordPress environment (recommended for testing the plugin in WP admin):

```bash
npx wp-env start
```

Then open the site and admin using the URLs wp-env prints (default dev port **8882**, tests **8883**).

## Local WordPress (wp-env)

Configuration is in **`.wp-env.json`** at the repo root:

- **WordPress:** Core version defined in config (e.g. tag 6.9.1).
- **PHP:** 8.1.
- **Ports:** 8882 (development), 8883 (tests).
- **Plugins:** Current directory is mounted as the Bluehost plugin; wp-env can also load other plugins (e.g. wpforms-lite via mapping).
- **Themes:** Can install themes (e.g. yith-wonder) via config.

Useful commands:

```bash
npx wp-env start    # Start the environment
npx wp-env stop     # Stop it
npm run log:watch   # Tail WordPress debug.log (when WP_DEBUG_LOG is on)
```

Set `WP_DEBUG`, `WP_DEBUG_LOG`, and `WP_DEBUG_DISPLAY` in `.wp-env.json` as needed for local debugging.

## Next steps

- **Architecture:** See [architecture.md](architecture.md) for how the plugin and modules are wired.
- **Frontend:** See [frontend.md](frontend.md) for the React app and routes.
- **Backend:** See [backend.md](backend.md) for PHP and REST API.
- **Daily workflow:** See [development.md](development.md) for lint, test, and version commands.

[-] frontend.md [edit]
[-] .htaccess [edit]
[-] testing.md [edit]
[-] workflows.md [edit]
[-] reference.md [edit]
[-] backend.md [edit]
[-] integrations.md [edit]
[-] api.md [edit]
[-] getting-started.md [edit]
[-] index.md [edit]
[-] release.md [edit]
[-] development.md [edit]
[-] architecture.md [edit]
[-] modules.md [edit]
[+] ..
[-] overview.md [edit]