Webship Workspace

A container-based development workspace with a web dashboard, for Webship projects: Drupal, Drupal CMS, the Webship products, and whatever else your folders hold. The core ships empty. Everything else is a plugin you add when you need it.

The core, its families and the plugins

Install

# 1. Node.js 20 or newer, Docker, and DDEV (https://ddev.readthedocs.io)
# 2. The workspace, from npm
npm install -g @webship.co/workspace
webship-workspace init ~/workspace       # the core, an empty settings file, the dashboard started

Open https://workspace.ddev.site. It is empty: no workspace folders, no plugins. Add what you need, one package at a time, from Settings → Plugins (the catalogue) or the command line:

webship-workspace plugin require dev     # npm install @webship.co/workspace-dev into the dashboard
webship-workspace plugin activate dev    # on the workspaces list
webship-workspace plugin install dev     # the folder, its settings file, its commands
webship-workspace catalog                # everything you can add

Nothing is added to package.json until you ask for it. The skeleton and the management stay in the core.

What a plugin is

An npm package @webship.co/workspace-<name> (repository github.com/webship/workspace-<name>, branch 1.0.x), written in TypeScript against @webship.co/workspace-plugin-api. Families share a base: hosting providers (upsun, acquia, digitalocean, cpanel, aws, azure, godaddy), git forges (github, gitlab, bitbucket), container runtimes (docker, lando, docksal, podman, kubernetes), and every workspace folder (dev, test, drupal-modules, drupal-themes, docs, images, ai-agents, …) is a plugin too.

Read more

Getting startedThe first hour: install, add a workspace folder, build a site. User guideThe pages of the dashboard and what each button does. The dashboard, page by pageA tour of the dashboard in screenshots. WorkspacesFolders, types, builders and the cmd-*.sh commands. Workspace folders: kinds, types and settingsThe kinds and types of a workspace folder and its settings file. PluginsThe four steps, the families and every plugin. TestingUnit tests and the webship-js browser suite. ReleasesVersions, npm, and how changes land. Developer guideHow the app is built: commands, builders, workspaces, the dashboard. ReferenceLayout, settings, the dashboard, building a project and the rest.

License

GPL-2.0-or-later. Made by Webship.