https://github.com/hypress/project-skeleton
💀A very basic project skeleton for hypress projects.
https://github.com/hypress/project-skeleton
ansible-playbook vagrant vagrantfile webpack wordpress-development wordpress-development-kit
Last synced: 10 months ago
JSON representation
💀A very basic project skeleton for hypress projects.
- Host: GitHub
- URL: https://github.com/hypress/project-skeleton
- Owner: hypress
- License: mit
- Created: 2019-02-10T20:18:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T11:15:34.000Z (about 3 years ago)
- Last Synced: 2023-03-02T11:21:03.877Z (almost 3 years ago)
- Topics: ansible-playbook, vagrant, vagrantfile, webpack, wordpress-development, wordpress-development-kit
- Language: Shell
- Homepage: https://github.com/hypress
- Size: 787 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hypress-project-skeleton (v0.1.3)
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][generator-hypress].
## Requirements
### Vagrant
1. [VirtualBox](https://www.virtualbox.org/)
2. [Vagrant](https://www.vagrantup.com/)
3. [vagrant-hostmanager](https://github.com/devopsgroup-io/vagrant-hostmanager)
### Docker
1. [Docker](https://docker.com)
2. [Docker Compose](https://docs.docker.com/compose/install/)
## Install dependencies with homebrew (macOS)
Run
```bash
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][generator-hypress].
To bring your development stack up, just start the vagrant box.
```bash
vagrant up
```
If you are using Docker, run
```bash
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.
```bash
cd .hypress/
mkcert hypress.local
```
If you ran `vagrant up` already, you need to provision the box again.
```bash
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
```bash
npm run bundle
```
You'll find a ready to use bundle in `./dist`.
## Contributing
This projects is open for contributions.
[hypress]: https://github.com/hypress
[generator-hypress]: https://github.com/hypress/generator-hypress
[mkcert]: https://github.com/FiloSottile/mkcert