ssdev makes Silverstripe development easy. Stop worrying about your LAMP, MAMP or WAMP stack and start developing awesome websites and applications!
🚨 WANTED: Feedback from Windows & Linux users!
ssdev is extensively tested and developed on macOS, as this is what we work on. To find bugs or problems on other systems, we need your feedback from using ssdev on Linux or Windows
For ssdev to work correctly, you have to install
- Docker (installation instructions) - We recommend to install Docker desktop on Windows, as a native installation under wsl tends to not work correctly.
- Node & npm (& npx) (installation instructions)
Users on Mac and Windows will have to set up nfs.
→ see 📚 Configuring NFS on macOS.
You can run ssdev without installing it using npx:
npx ssdev --help
This works great for checking out ssdev or for issuing some commands, but for productive development work, you should install it globally using:
npm install -g ssdev
after which you can simply use it by typing
ssdev --help
ssdev assumes Silverstripe projects to be inside a directory containing a composer.json
file and a file structure common for Silverstripe.
All commands concerning that project must be executed in the project root.
If you want to experiment on a new project, have a look over at syntro/ssto
to get set up with a Silverstripe starter project.
In a directory containing a project, simply run
ssdev up
to bring up a server and database environment. To shut down the server after you are finished, run
ssdev down
There is more to ssdev, but we go over all of it in the docs.
ssdev is a powerful tool and can be customized in various ways. Read here how you can achieve any setup, mimicking a production environment as closely as possible.
You can set all config options (ssdev --help) in a package.json file under the
ssdev key. This allows you to set per-project settings that actually transfer
to other developers. An example would be if you want to use a different PHP version:
{
"ssdev": {
"image-host": "syntrocontainer/silverstripe-dev:8.0-apache-buster"
}
}→ see 📚 in-depth docs about how to work with diffrent hosting setups.
→ see 📚 in-depth docs about composer dependencies.
→ see 📚 in-depth docs about test execution.
→ see 📚 in-depth docs about custom service container.
On macOS or Windows, you may instruct ssdev to mount the host directory via NFS. In the past, this has worked
well for improving performance, but with the addition of new and faster file-sharing implementations,
this has become a legacy feature and has been disabled by default in version 1.3.0.
If you want to re-enable it, simply add the --use-nfs flag or add the following to your config:
{
"ssdev": {
"use-nfs": true
}
}→ see 📚 Configuring NFS on macOS.
Check out the following for more informations: