Hello world
This repository contains the source code, content and configuration for https://stuar.tc, the personal website of Stuart Clark.
This is a DruxtJS, Fully Decoupled Drupal & Nuxt.js site, built with the Drupal Tome module for file based content, with the intent of being developed in the cloud and deployed to CDN, and to operate serverless and databaseless.
DDEV is an open source tool that makes it dead simple to get local PHP development environments up and running within minutes.
DDEV is used to manage the Drupal instance, and provides a CLI that can be used to run common drupal tasks, including ddev drush.
These commands must be run from within the drupal folder.
# Start the environment
cd drupal
ddev start
ddev installSee the wiki for full setup instructions.
The environment contains a running instance of Drupal and Nuxt.
You can access the services in your browser, via the Remote Explorer extension, or via the URL pattern: https://[PORT]-[GITPOD_ID].[GITPOD_SERVER].gitpod.io
| Port | Service |
|---|---|
3000 |
Nuxt.js |
3003 |
Storybook |
8080 |
Drupal |
The project uses GitHub Actions for continuous integration:
- Linting: ESLint, Stylelint
- Testing: Jest (unit), Cypress (E2E)
- Coverage: Codecov
- Deployment: Netlify (automatic on main branch)
See .github/workflows/ci.yml for the workflow configuration.
The frontend is deployed to Netlify. Deployment happens automatically on pushes to main. The build command is yarn generate and outputs to nuxt/dist.
DDEV is used to manage the Drupal instance, and provides a CLI that can be used to run common drupal tasks, including ddev drush.
These commands should be run from within the /drupal folder.
Refer to the documentation for more details: https://ddev.readthedocs.io
Storybook integration with NuxtJS .
Druxt integrates with the Nuxt Storybook module to provide zero-configuration, auto-discovery stories with access to live data from your Drupal backend.
To start Storybook, navigate to the nuxt directory and run npx nuxt storybook.
See the wiki/ directory for detailed documentation:
| Page | Description |
|---|---|
| Architecture | Nuxt + Drupal + DruxtJS stack overview |
| Development Setup | Local and cloud development environment |
| Testing Guide | Jest, Cypress, and PHPUnit testing |
| Troubleshooting | Common issues and solutions |
| Upgrade Notes | Drupal upgrade paths |