A docker-based development environment aimed at letting you quickly and easily spin-up dev environments for different project types, with minimal fuss and learning curve.
ruby 3.0.2+ - sudo apt install ruby-full
Clone the git repo and enter the directory
git clone https://github.com/cwarwicker/quick-dev/ dev
cd devRun the bundle script to install all the required Ruby gems.
bundle installMake a quick-dev config directory within your home directory.
mkdir ~/.config/quick-devCopy the config file across to the newly created config directory.
cp config ~/.config/quick-devEdit your ~/.bashrc file and add the following line to the end:
source ~/.config/quick-dev/configAnd reload your .bashrc file with source:
source ~/.bashrcConfirm Quick-Dev is installed correctly and your alias is working by running:
qd versionYou should see output like:
Quick-Dev 1.0
Made by Conn Warwicker
For any issues or feature requests, see: https://github.com/cwarwicker/quick-dev)
Clone your project into its own directory within the /apps directory.
E.g.
git clone https://github.com/<user>/<project> apps/my_project
cd apps/my_projectRun the config command within your project.
qd config(Note: There are some preset configurations which you can choose from instead of rolling your own. To select one of these add the -p or --preset flag. E.g. qd config --preset)
This will bring up a series of menus to choose the project type, image, etc... as well as any other services required, such as database, caching, etc...
Currently Quick-Dev supports the following project types:
- Laravel
- Moodle
- PHP (General)
- Other
You can still use Quick-Dev with any type of project you like, it's just that project-specific configuration and commands have been added for the supported list.
You can choose from the pre-built images for the supported project types (See: .docker/images/ if you want to see what they contain). Or you can choose custom and just type in any docker image to pull.
Database
Currently you can choose from the following pre-defined database engines:
- MariaDB
- MySQL
- PostgreSQL
And for each supported database engine, you can choose from any of their LTS versions.
Again, you can also choose custom and put in any docker image you want to pull for a different database engine, however, just remember that if you choose something different, but used a pre-built application image, it may not have the correct drivers/extensions, so you might need to do a custom application image as well.
Caching
Currently you can choose from the following pre-defined caching engines:
- Redis
And for each supported database engine, you can choose from any of their LTS versions.
Again, you can also choose custom and put in any docker image you want to pull for a different caching engine.
Once you have finished with the config, you should find a cfg.yaml file in your project directory.
Next, you can simply start the project by running:
qd upThis will create the docker-compose.yml file based on your config info, and bring up all the containers.
qd help - Displays the help information
qd version - Displays the verison of Quick-Dev you are running.
qd config - Runs the project configuration wizard
qd up [-r|--rebuild] - Starts the project containers (and core Quick-Dev containers). The -r or --rebuild flag will force a re-build instead of using the cached images.
qd stop [-a|--all] - Stops the project containers. The -a or --all flag will also stop the core Quick-Dev containers.
qd destroy [-a|--all] - Stops and deletes the project containers. The -a or --all flag will also stop and delete the core Quick-Dev containers.
qd remove - Stops and deletes the project containers, removes any project-specific files elsewhere, and finally deletes the whole project directory.
qd connect [container] - Connects to a docker container and runs a bash terminal. By default this will be your main application container. The container argument lets you specify any container name to try and connect to.
qd services [-a|--all] - Lists all your project services, their statuses and any URLs. The -a or --all flag also lists the core Quick-Dev services.
qd cmd [command] - Runs any specified command on the application container. The command flag contains the command you want to run. For example qd cmd echo 'Hello' will connec to the application container and run the command echo 'Hello'. So this can be used to run essentially anything you want to on the application container.
These are pre-defined commands you can run without having to prefix with cmd.
Laravel
qd artisan [command] - Run the specified artisan command on the application container.
Moodle
qd install - Runs the Moodle installation script, using pre-defined defaults.
qd upgrade - Runs the database upgrade script.
qd purge - Runs the purge caches script.
All
qd composer [command] - Run the specified composer command on the application container.
-
Add pre-set project configurations
-
Add support for more project types
-
Why did a git patch fail to apply when I created a
moodleproject?Moodle currently doesn't support the web server Quick-Dev uses (Caddy), though there is an opten tracker item for it: https://tracker.moodle.org/browse/MDL-83391 So we have to apply a patch to the setuplib.php to let it work. If this fails or conflicts, you'll need to double check your setuplib.php to make sure it's got the patch in it. See:
.docker/templates/moodle/01_caddy.patch -
I created a Moodle or Totara project but it errors on "Caddy is not available"
When you create a Moodle/Totara project via a preset configuration, a patch should be applied automatically (see above) to fix the problem of the codebase not allowing certain web servers. If you craete the project manually, you'll need to apply that patch manually as well, e.g.
git apply ./docker/templates/moodle/01_caddy.patchorgit apply ./docker/templates/totara/01_caddy.patchNOTE: In Moodle 5.0 and above this is not necessary.