Search by

clesson-de / silverstripe-developertools

clesson-de

CMS developer tools with project versions, Composer packages, routes and a token-protected JSON endpoint.

Package info

github.com/clesson-de/silverstripe-developertools

Type:silverstripe-vendormodule

pkg:composer/clesson-de/silverstripe-developertools

Statistics

Installs: 154

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

1.1.2 2026-11-08 16:20 UTC

This package is not auto-updated.

Last update: 2026-11-08 16:21:46 UTC


README

Developer tooling for Silverstripe CMS in one admin area: monitoring, overlays, offline mode and project analysis.

Documentation

README.md is the entry point. Feature details live in docs/en.

Guide Contents
Website Monitoring Protected JSON API, health checks, version history, notifications, scheduled checks
Offline Page and Maintenance Mode Setup, activation, static export, scheduling, IP exceptions
Frontend Overlays Targeting, scheduling, rendering, caching, asset build and release workflow

Core capabilities

  • Dashboard: single shared DeveloperToolsConfig with dashboard panels.
  • Monitoring: central website inventory, health status and notifications.
  • Overlays: CMS-managed frontend notices with audience and time filters.
  • Offline mode: static maintenance page with scheduling and IP exceptions.
  • Analysis: project info, Composer packages and registered routes.

Installation

composer require clesson-de/silverstripe-developertools
vendor/bin/sake db:build --flush
composer vendor-expose

Supported versions

This package supports:

  • PHP 8.5
  • SilverStripe 6
  • SilverStripe CMS 6
  • SilverStripe Admin 3
  • SilverStripe Assets 3
  • SilverStripe Versioned 3

Configuration

The module is installed as a standard SilverStripe vendormodule and is available in the CMS admin menu after rebuilding the project.

After installation, run:

composer require clesson-de/silverstripe-developertools
vendor/bin/sake db:build --flush
composer vendor-expose

Then open the Developer Tools area in the CMS. No custom bootstrap code is required for the default setup.

Quick usage

Open Developer Tools in the CMS menu (ADMIN permission required):

  1. Dashboard
  2. Monitoring
  3. Overlays
  4. Offline mode
  5. Analysis

After upgrades, rerun:

vendor/bin/sake db:build --flush
composer vendor-expose

Release check (assets)

Compiled frontend/admin assets are intentionally versioned in this repository and must not be ignored by Git. Before handover or release, rebuild and commit all changed files in client/admin/dist and client/frontend/dist.

npm install
npm run build
npm test
composer vendor-expose

Detailed asset workflow is documented in Frontend Overlays.

Repository hygiene

  • Team-wide recurring artifacts belong in .gitignore.
  • Personal/local-only artifacts belong in .git/info/exclude.

Example (.git/info/exclude):

# local editor/cache files (personal)
.vscode/
*.swp

Requirements

  • Silverstripe Framework ^6
  • Silverstripe Admin ^3
  • Silverstripe CMS ^6
  • Silverstripe Assets ^3
  • Silverstripe Versioned ^3
  • clesson-de/silverstripe-dashboard ^1
  • clesson-de/silverstripe-markdown ^1
  • clesson-de/silverstripe-hints ^1
  • clesson-de/silverstripe-gridfield-pro ^2
  • lekoala/silverstripe-encrypt ^5
  • PHP ^8.5 with cURL extension

License

This project is licensed under the BSD-3-Clause license. See LICENSE for the full text.