Skip to content

hypress/project-skeleton

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hypress-project-skeleton (v0.1.3)

Version Last commit Build status WordPress v5.2.4

A very basic project skeleton for hypress projects. The main goal is to keep as much as dependencies away from the host machine.

The base project skeleton for hypress driven WordPress projects.

This skeleton can be generated with the yeoman hypress generator.

Requirements

Vagrant

  1. VirtualBox
  2. Vagrant
  3. vagrant-hostmanager

Docker

  1. Docker
  2. Docker Compose

Install dependencies with homebrew (macOS)

Run

brew install cask
brew cask install virtualbox vagrant
vagrant plugin install vagrant-hostmanager

Getting started

You need a copy of all project files. Download it via github or just use the yeoman hypress generator.

To bring your development stack up, just start the vagrant box.

vagrant up

If you are using Docker, run

docker-compose up
Endpoint URL
Frontend http://hypress.local
Backend http://hypress.local/wp-admin
phpMyAdmin http://hypress.local/phpmyadmin
Docker Frontend http://hypress.localhost
Docker Backend http://hypress.localhost/wp-admin
Docker phpMyAdmin http://hypress.localhost/phpmyadmin
Credential Value
MySQL user hypress
MySQL password hypress
MySQL database hypress
WordPress user hypress
WordPress password hypress

Enable local https (Vagrant only)

To get local https, you can utilize mkcert. Follow the link for installation instructions.

After installing mkcert and creating a local CA create a certificate for hypress.

cd .hypress/
mkcert hypress.local

If you ran vagrant up already, you need to provision the box again.

vagrant provision

Plugin development

If you want to use this setup for WordPress plugin development, change the hypress_type variable in ./.hypress/ansible/settings.yml from theme to plugin.

Bundle your theme or Plugin

To create a production ready release, just run

npm run bundle

You'll find a ready to use bundle in ./dist.

Contributing

This projects is open for contributions.