0.1.2 • Published 3 years ago

@bjarnbronsveld/sheepdog v0.1.2

Weekly downloads
-
License
GPLv3
Repository
github
Last release
3 years ago

Sheepdog npm.io

A blazing fast local development environment for MacOS written in Typescript. soon to be cross-platform!

npm.io

What is Sheepdog?

Sheepdog allows you to setup a complete local development environment in just a couple of seconds. Literally the only thing you have to do is run sheepdog install and you're done.

Walk through the installation steps, which allow you to select which PHP versions (multiple!) you'd like to run or which kind of database server (i.e. MySQL 5.6 or 8.0, but also MariaDB).

Sheepdog is currently still under heavy development and not ready to be used as your daily driver. However, it works but lacks error messages, useful notices and yes, might contain bugs.

The name 'Sheepdog' will change in the future, any suggestions are welcome!

Services are using optimized configs (credits to Valet+) to improve the performance of your local development environment.

Why Sheepdog?

It has a completely different approach compared to services like Laravel Valet and aims to be both flexible and performant.

Instead of using a single 'server.php' file which proxies every request, we just use Nginx configuration files per site. Don't be afraid though! We made it as easy as possible. We'll even introduce templates** for certain projects very soon!

** Templates allow you to link a site with a specific app configuration for Nginx. I.e. an optimized config for Laravel or Magento 2.

Included services

The following services are currently installed by Sheepdog. Services marked with a * are optional, you can uncheck them ;-).

  • Nginx
  • Dnsmasq
  • PHP (7.1, 7.2, 7.3, 7.4 and 8.0)
  • MySQL (MySQL 5.7, 8.0 and MariaDB)
  • Redis*
  • Elasticsearch*

Dev tools

The following development tools are included.

  • Mailhog
  • wp-cli (soon!)*
  • magerun (soon!)*
  • magerun2 (soon!)*
  • drush

Migrating from...?

Are you migrating from Valet or Valet+? Hold on! We'll have a migration guide ready for you soon.