This code runs the https://frees.au/ce website. This site is a very simple blog site, and used to support the creation of training videos which you can find on the Free Sauce youtube channel.
This code is licensed GPL-2.0-or-later. This code is provided for you to examine and mock (in all senses of the term).
The Free Sauce logo, brand and assets which ship in this repository are Copyright Free Sauce 2024. (Copy the theme if you want, but replace the logo and company name please!).
The goal of this project is to build Drupal as simple and elegantly as possible while also being an actual production codebase. There is a mix of best practice, personal preference and practicality.
There is zero intention to package this up as a product or distribution. This is because Drupal moves fast, and we want this project to keep up with it.
Please feel free to discuss anything you like. You can be critical too. If you like a conversational approach to reviewing this code, check out the video below.
¿Por qué no los dos?
You should be able to install locally with DDEV
or Lando. Anhy instructions with ddev|lando ... you should modify
to use your preferred. If it only shows ddev we are waiting the next version of Lando.
ddev|lando start
ddev|lando composer install
ddev|lando scratch # Build the site with content captured in fs_test module.
ddev|lando drush uli
If you are an employee with access to the hosting environment you can do
ddev refresh. And @see .ddev/commands/host for more.
This is a very simple and somewhat unfinished Tailwind theme with no base theme dependencies. It's intended for learning and copying rather than being something we expect you to use as a base theme. Please don't ask for support if you do 😬.
Install the css with the following command, just to get you started.
ddev|lando frontend
Static tests run easily in the container.
ddev static # PHPStan and PHPCS.
ddev cypress # Currently hangs locally, working in Github Actions.
Note that for Cypress E2E testing, the ddev cypress command works for us on
OSX, but note these are optimised for our local cypress experience and if we
can't predict if it will run for you on your machine. Read the code here
./ddev/commands/host/cypress.
You can work on contrib modules in this repo. For example if you check out a contrib module repo, you could run tests on the module.
ddev composer run-script phpcs -- ./web/modules/contrib/foo_module
ddev composer run-script phpcbf -- ./web/modules/contrib/foo_module
ddev composer run-script phpstan -- ./web/modules/contrib/foo_module
# phpunit tba
This site is open source but our production database isn't, so we provide the
ability to build it from scratch using ddev scratch. This installs a minmal
Drupal site, imports the config, and adds some baseline content that is captured
in the fs_test module to create a fully functioning site.
This type of build is great for e2e integration testing since it doesn't need access to production database sync or database stubs. It is supported by the excellent Default Content module.