antpb/three-object-viewer

A WordPress plugin for drag and drop 3D content creation compatible with most XR devices.

JavaScriptGPL-2.0

Three Object Viewer

Installation

Download the from WordPress or install by searching for "Three Object Viewer" in the plugin repository in wp-admin. https://wordpress.org/plugins/three-object-viewer/

Local Development

Git clone:
- git clone git@github.com:antpb/three-object-viewer.git
Install javascript dependencies
- yarn
Install php dependencies
- composer install

Working With JavaScript

Build JS/CSS
- yarn build
Start JS/CSS for development - currently broken
- yarn start
Test changed files - pending tests
- yarn test --watch
Test all files once
- yarn test
- yarn test --ci

Working With PHP

Autoloader

PHP classes should be located in the "php" directory and follow the PSR-4 standard.

The root namespace is threeObjectViewer.

Tests

Run unit tests
- composer test:unit
Run WordPress tests
- composer test:wordpress
- See local development instructions for how to run with Docker.
Run unit tests and WordPress tests
- composer test

Linter

PHPCS is installed for linting and automatic code fixing.

Run linter and autofix
- composer fixes
Run linter to identify issues.
- compose sniffs

Local Development Environment

A docker-compose-based local development environment is provided.

Start server
- docker-compose up -d
Acess Site
- http://localhost:6039
WP CLI
- Run any WP CLI command in container:
  - docker-compose run wpcli wp ...
- Setup site with WP CLI
  - docker-compose run wpcli wp core install --url=http://localhost:6039 --title="Three Object Viewer" --admin_user=admin0 --admin_email=something@example.com
  - docker-compose run wpcli wp user create admin admin@example.com --role=administrator --user_pass=pass

There is a special phpunit container for running WordPress tests, with WordPress and MySQL configured.

Enter container
- docker-compose run phpunit
Composer install
- composer install
Test
- composer test:wordpress