Skip to content

rwth-pads/ocelescope

Repository files navigation

Ocelescope

🔗 Documentation: https://rwth-pads.github.io/ocelescope

⚠️ Project Status: Under Construction

This repository is under active development and is not production-ready yet. Expect frequent changes, incomplete features, and potential bugs.

Contributions, feedback, and testing are welcome!


⚙️ Installation & Usage

These instructions are intended for developing Ocelescope locally.
If you only want to run Ocelescope, please follow the installation steps in the documentation linked above.


🧱 Prerequisites

Make sure you have the following tools installed:


🚀 Getting Started

To set up the project for the first time, run:

just sync

This installs backend and frontend dependencies and synchronizes API clients.


▶️ Development Scripts

Ocelescope uses just as a task runner, so you can execute commands from anywhere in the repository.

Command Description
just docs Launch documentation locally at http://localhost:8000/ocelescope/
just orval Update the frontend API client
just sync Install backend and frontend packages, then sync API clients
just up dev Run Ocelescope in development mode at http://localhost:3000
just up prod Build and run Ocelescope (production) at http://localhost:3000

To list all available commands:

just

About

An Extendable Web Framework for Object-Centric Event Logs

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors