Getting up and running with the blökkli starterkit is straightforward. You can quickly spin up a demo site on your local machine.
You need to install either DDEV or Lando in order to run the starterkit.
- Follow the instruction to install DDEV on your machine (if not already installed): https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/
- After installing DDEV, check if the
ddevcommand is working in your terminal - Make sure you have run
mkcert --installto set up local SSL certificates
You are ready to use the automated setup script in the next section.
- On OSX, follow the documentation: https://docs.lando.dev/install/macos.html
- On Linux, follow the documentation: https://docs.lando.dev/install/linux.html
- On Windows, install Lando inside a WSL2 enabled distro: https://docs.lando.dev/install/windows.html
- As soon as the lando command is working in your terminal
You are ready to use the automated setup script in the next section.
This script setups up a working local environment with Drupal and Nuxt frontend in a few minutes.
It is recommended to create a free account on rokka.io and get your API key to use the image CDN. During the setup process, you will be asked to provide the API key and the organisation name.
All image handling, processing and optimization is done by rokka.io. You can create a free account and set up a new organization at https://rokka.io/dashboard/#/signup.
You will get an API key and an organisation name.
Start script and provided the desired setup type (ddev or lando).
./scripts/local/init-project.sh (ddev | lando)This will:
- Set up the necessary
.envfiles. - Run
composer installwithin the container. - Import demo database.
- Upload some demo images to rokka.io and set up the image styles.
- Install all frontend dependencies with a clean state using
bun install. - Rebuild all styles.
- Ask you to start the frontend in development mode.
After running the script, you can log in in the Drupal backend using one of the URLs:
- https://starterkit.ddev.site/user (for DDEV)
- https://starterkit.lndo.site/user (for Lando)
with the credentials generated during installation. Defaults to admin / password.
Now you can visit the frontpage and start building your first page with blökkli.
| Command | Description |
|---|---|
ddev launch |
Opens the site in a new browser window. Note: You won't see the Nuxt frontend unless you have started it with ddev frontend |
ddev frontend |
Start the frontend. Same as running ddev bun run dev. |
ddev restart |
Restart ddev. |
ddev poweroff |
Powers off ddev. |
| Script description | DDEV | Lando |
|---|---|---|
| Copy live to self | ddev copy-live-to-self |
lando drupal:copy-live-to-self |
| Copy stage to self | ddev copy-stage-to-self |
lando drupal:copy-stage-to-self |
| Regenerates the Nginx configurations | ddev regenerate-nginx-config |
lando regenerate-nginx-config |
| Check and update locales (translations) | ddev drupal-check-and-update-locale |
lando drupal:check-and-update-locale |
| Re-index Search API indices | ddev drupal-reindex-search-api-indices |
lando drupal:reindex-search-api-indices |
| Composer Update Info | ddev drupal-composer-update-info |
lando drupal:composer-update-info |
Both Drupal and the frontend app are accessible on the same domain: https://starterkit.ddev.site (for DDEV) or https://starterkit.lndo.site (for Lando).
The requests are routed to the correct app. For example, /de is routed to the frontend and /admin is routed to
Drupal.
This means that if the frontend is not running, exped.lndo.site will
automatically fall back to the Drupal backend. Drupal is available via /admin.
Add the routes you would you like to be handled in drupal inside scripts/nginx-conf-generator/config/base.yml file.
Run ddev regenerate-nginx-config (for DDEV) or lando regenerate-nginx-config (for Lando)
- SSH into the container using
ddev ssh(for DDEV) orlando ssh -s frontend(for Lando) - Run
npm ci && npm start.
Simply run ddev restart (for DDEV) or lando reload (for Lando)