Skip to content

underground-works/clockwork-app

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 application component of Clockwork.

Check out on the Clockwork website for details.

Installation

Clockwork browser extension can be installed from official distribution channels:

The server-side component also includes a full copy of the Clockwork app available at your.app/clockwork.

Clockwork uses a server-side component, that gathers all the data and easily integrates with any PHP project, including out-of-the-box support for major frameworks.

Read the full installation guide on the Clockwork website.

Development

Use npm run serve to run a development server with hot reloading.

It might be useful to force a specific server-side url when running the development server. This can be done by creating a .env.development file:

VUE_APP_STANDALONE_REMOTE_HOST=http://127.0.0.1:8000
VUE_APP_STANDALONE_REMOTE_PATH=__clockwork/

The Clockwork app can be build for following targets:

  • npm run build-chrome - build Chrome extension in dist/chrome
  • npm run build-firefox - build Firefox extension in dist/firefox
  • npm run build-edge - build Edge extension in dist/edge
  • npm run build-web - build standalone web application in dist/web

To make a development build with source-maps append -dev to the target, eg. build-chrome-dev.