Backend repository for youvo based on Drupal 10.
We are building the new backend for youvo.org - a platform that connects social organizations with creatives for skill-based volunteering projects. The backend of the main platform runs on Drupal 7. We are migrating to a decoupled stack with Drupal 10 and Remix. The current development phase is until the end of June. Most of the features are still in early development and highly unstable. The Academy is running as a beta on beta.youvo.org (after registration).
We are not using the issue queue in this repository, yet. Just write an email to [email protected]
For the local development environment, we use DDEV based on Docker. For the system requirements, please see DDEV docs.
Tested on Linux with Ubuntu 22.04.2 LTS composer 2.8.4 docker 27.4.0 ddev 1.24.0.
Tested on macOS with macOS Sequoia 15.1.1 composer 2.8.4 docker desktop 4.36.0 ddev 1.24.0.
Further installation steps may be required to set up SSH agent and XDebug, see DDEV troubleshooting.
Composer is based on the package drupal/core-recommended. The configuration can be found in composer.json. Patches are defined in composer.patches.json. The patch files are located in the folder patches.
mkdir youvo-backend
cd youvo-backend
git clone [email protected]:youvo/backend.git .
# You may need to set up some configuration - see below.
ddev config --auto
# Optional crontab for local development.
ddev add-on get ddev/ddev-cron
ddev composer install
./scripts/install-local.shNavigate to https://youvo.ddev.site:8443/user/login and login with [email protected]:admin.
- DDEV configuration
.ddev/config.yml - Drupal setup parameters
config/.env.local - Consumers configuration
config/.env.consumers.development - OAuth Remote configuration
config/.env.oauth_remote.development - API configuration
config/.env.api - XDebug port
.ddev/php/xdebug_client_port.ini - Simple OAuth certificates, see
config/certs/README.md
Adjust the config path in web/sites/default/settings.php such that $settings['config_sync_directory'] = '../config/sync';.
Set $settings['file_public_path'] = 'files';.
Set $settings['file_assets_path'] = 'assets';.
Set $settings['file_private_path'] = '../private';.
Note that some of the environment variables files will be merged in the future. We entertain some separation at the moment for development purposes.
ddev help # show commands help
ddev drush foo # execute Drush commands
ddev status # show status of containers
ddev start # start containers
ddev stop # destroy containers
ddev logs # show php logsInstall via ddev add-on get ddev/ddev-phpmyadmin and navigate to https://youvo.ddev.site:8037 and login with db:db. The database is youvo_local.
In some system configurations dummy content folders require further permissions.
cd web/sites/default/files
chmod 0666 -R academy projects creatives organizations
You may use the DDEV Integration plugin or configure the database connection as follows.
- Host:
localhost - Port:
59002 - Database:
db - User:
db - Password:
db
We have four different testsuites: unit, kernel, functional and existing-site. You can run them locally with the following command.
vendor/bin/phpunit --testsuite unit --configuration phpunit.ddev.xml
- https://www.drupal.org/node/1419988
- Set in idea configuration file
<option name="CODING_STANDARD" value="Drupal,DrupalPractice,PHPCompatibility" />
To set up a Drupal distribution with the youvo_development profile, do the following:
git clone [email protected]:youvo/backend.git
cd backend
cp config/.env.example config/.env.development # and adjust settings
cp config/.env.api.example config/.env.api # and adjust settings
cp config/.env.consumers.example config/.env.consumers.development # and adjust settings
cp config/.env.oauth_remote.example config/.env.oauth_remote.development # and adjust settings
composer install
./scripts/install-development.shThis includes development modules such as devel, coder, phpcodesniffer, phpunit, admin_toolbar and more. Also, it will install dummy content from the (dummy_) sub-modules of youvo, creatives, organizations, projects and academy.
The database is youvo_dev.
To set up a Drupal distribution with the youvo_platform profile, do the following:
git clone [email protected]:youvo/backend.git
cd backend
cp config/.env.example config/.env.production # and adjust settings
cp config/.env.api.example config/.env.api # and adjust settings
cp config/.env.consumers.example config/.env.consumers.development # and adjust settings
cp config/.env.oauth_remote.example config/.env.oauth_remote.development # and adjust settings
composer install
./scripts/install-production.shThis provides a clean-state installation. For the login you may need to navigate to /user/login, because the site is in blocker mode (see /admin/config/development/blockermode). The administration can be found under /admin/index and /admin/configuration.
The database is youvo_prod.
make help # show commands help
make mm-on # maintenance mode on
make mm-off # maintenance mode off
make cr # clear caches
make warm # warm caches
make warm-images # warm up image styles
make gi # generate queued image styles
make fis # flush all image styles
make install # (re-)install Drupal (only available in development)
make rebuild # calculate rebuild token
make restart-php # restart Uberspace php
make phpstan %PATH # run PHPStan analysis at specified path
make phpcs # run PHP_CodeSniffer analysis for custom modules
make phpcbf # run PHP_CodeSniffer automatic fixes for custom modulesDeploy is defined in the script scripts/deploy.sh.