This repository contains a modified version of the iSpy WebGL Event Display, which has been adapted for the masterclasses at the University of Hamburg. The original version of the iSpy WebGL Event Display was developed by the CMS Collaboration (contributors: F. Ali, L. Barnard, M. Hategan, S. Lee, C. Logrén, T. McCauley, P. Nguyen, M. Saunby) and is available at the following links:
This guide provides instructions for developers who want to edit, expand functionalities, or contribute to the event display project. It covers the setup of the development environment, cloning the repository, installing dependencies, and running the application in development mode.
- Node.js: Download
You can either download the repository as a ZIP file or clone the repository using Git (recommended). If you want to contribute to the project, it is highly recommended to fork the repository to your personal GitHub account and clone the fork.
Then, follow these commands:
# Clone the repository using git clone.
# (Adjust the URL if you're using a fork)
$ git clone [email protected]:uhh-cms-tutorials/masterclasses.git
$ cd masterclasses/
# Installing Dependencies
$ npm update
# After npm installs all dependencies, you should be ready to code
# Compile the TypeScript code to JavaScript and bundle everything using webpack
$ npm run build
# For debugging purposes, process using the development mode for TypeScript and webpack
$ npm run build:dev
# For testing, start a server and run the website locally
$ npm test- The main code files are located in the
ts/directory. - The webpage can be found in the
index.htmlfile. - The processed and bundled files will be output to the
dist/directory. - The
dist/directory also contains all assets used by the website, including stylesheets, images, and locale files for translations.
Look for the Help section in the application for guides on how to use the event display or set it up for the masterclasses.