Jump to heading # Developing on local machine with ddev

More information about ddev can be found at on official ddev website.

Dependencies are managed using Composer.

Jump to heading # Pre-requisite

Jump to heading # Software Requirements

• docker v20.10.17 or later
• ddev v1.22.0 or later
• composer 2.5.8 or later
• phabalicious 3.8.25 or later

Before setting up this project, it would be nice if you familiarize yourself in running a Drupal 10 ddev site locally on your machine. Following link could help you get started

• DDEV installaion guide
• DDEV quick start for Drupal guide

Jump to heading # Local environment setup

Jump to heading # Installation

1. Checkout project repo and confirm the path is in docker's file sharing config (more info).

   git clone ssh://git@source.factorial.io:2222/showcase/circle-dot.git && cd circle-dot
   

2. Make sure you don't have anything running on port 80 and 443 on the host machine (like a web server)

3. Initialize and start ddev

   ddev start
   

4. Go to sites default directory (./web/sites/default/) and copy settings.local.php.sample to settings.local.php

   cd web/sites/default/
   cp settings.local.php.sample settings.local.php
   

5. Install the project

   phab -cddev install
   

   Select yes, when it asks if it should install a new database.

   phab -cddev reset
   

6. Visit the new site at https://circle-dot.ddev.site

7. In case you want to log in the backend as administrator, you can retrieve a secret link to do so by running the following command

   phab -cddev drush uli
   

Jump to heading # Regular development

Run ddev start to start the project.

You can run phab commands against ddev to install, copyFrom, reset etc. For for information about available commands ands its usage please check out docs.phab.io

Example usage phab -cddev reset.

Jump to heading # Work in Progress

Following integration doesn't work at the moment, but would be supported soon.

• SOLR integration
• PDF generation
• Single Sign On
• Redis

Jump to heading # FAQ

Q: I get an error when running some ddev commands, what should i do?

A: When ddev commands fails, usually they provide troubleshooting suggestions in the terminal output. Reading them provides valuable hint to unblock yourself.

Q: I get following error that port 443 is already in use

Failed to start circle-dot: Unable to listen on required ports, port 443 is already in use,
Troubleshooting suggestions at https://ddev.readthedocs.io/en/stable/users/basics/troubleshooting/#unable-listen

A: Try docker stop haproxy and see if it resolves the issue. Otherwise visit the detailed troubleshooting suggestions provided by ddev

Q: ddev start fails with "Error response from daemon: error while creating mount source path"

Error response from daemon: error while creating mount source path '/host_mnt/Users/shibindas/work/ddev/circle-dot/.ddev': mkdir /host_mnt/Users/shibindas/work/ddev/circle-dot/.ddev: no such file or directory'

A: Do ddev poweroff and restart docker. After docker is up and running try ddev start again.