Skip to content

Clockwork - php dev tools in your browser - client-side metrics and toolbar

License

Notifications You must be signed in to change notification settings

underground-works/clockwork-browser

Repository files navigation

Clockwork is a development tool for PHP available right in your browser. Clockwork gives you an insight into your application runtime - including request data, performance metrics, log entries, database queries, cache queries, redis commands, dispatched events, queued jobs, rendered views and more - for HTTP requests, commands, queue jobs and tests.

This repository contains the client-side metrics and toolbar components of Clockwork.

Check out on the Clockwork website for details.

Installation

This is an optional client-side component for Clockwork, adding support for client-side metrics and Clockwork toolbar.

Via NPM

Clockwork client-side component can be installed via npm:

$ npm install clockwork-browser

Next simply import the metrics, toolbar or both in your app.js:

import 'clockwork-browser/metrics'
import 'clockwork-browser/toolbar'

From CDN

You can also load the client-side scripts form a cdn:

<script src="https://cdn.jsdelivr.net/gh/underground-works/clockwork-browser@1/dist/metrics.js"></script>
<script src="https://cdn.jsdelivr.net/gh/underground-works/clockwork-browser@1/dist/toolbar.js"></script>

The cdn builds are transpiled to support all browsers with more than 1% market share. The cdn bundle sizes are 8.29K for metrics.js and 33.4K for toolbar.js.

Read the full installation guide on the Clockwork website.

Development

Use npm run build to build the cdn bundles.