https://github.com/ecsx-framework/ecsx_live_dashboard

Adds an ECSx page to Phoenix Live Dashboard
https://github.com/ecsx-framework/ecsx_live_dashboard

Last synced: about 2 months ago
JSON representation

Adds an ECSx page to Phoenix Live Dashboard

• Host: GitHub
• URL: https://github.com/ecsx-framework/ecsx_live_dashboard
• Owner: ecsx-framework
• License: gpl-3.0
• Created: 2023-02-18T01:05:28.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-07-12T19:47:31.000Z (over 1 year ago)
• Last Synced: 2024-11-18T11:27:36.223Z (2 months ago)
• Language: Elixir
• Size: 313 KB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ECSx.LiveDashboard

[![Hex Version](https://img.shields.io/hexpm/v/ecsx_live_dashboard.svg)](https://hex.pm/packages/ecsx_live_dashboard)

[![License](https://img.shields.io/hexpm/l/ecsx_live_dashboard.svg)](https://github.com/APB9785/ecsx_live_dashboard/blob/master/LICENSE)

![ECSx LiveDashboard](assets/images/screenshot.png)

Adds an [ECSx](https://github.com/APB9785/ECSx) page to Phoenix LiveDashboard

## Features

* Monitor Systems load compared to your app's maximum capability at the current tick rate

* Compare the load of each individual System to identify where optimizations would be most beneficial

* Observe the quantity of each Component type, to ensure Components are being created and/or deleted properly

* Inspect current Component values to check data integrity

## Requirements

Your ECSx application must use Phoenix and have Phoenix LiveDashboard 0.8+ installed

## Installation

The package can be installed by adding `ecsx_live_dashboard` to your list of dependencies in `mix.exs`

```elixir

def deps do

  [

    ...

    {:ecsx_live_dashboard, "~> 0.1"},

    ...

  ]

end

```

Then modify the `live_dashboard` call in your `router.ex` to include ECSx LiveDashboard as an additional page:

```elixir

live_dashboard "/dashboard",

  metrics: MyAppWeb.Telemetry,

  additional_pages: [

    ecsx: ECSx.LiveDashboard.Page

  ]

```

## License

Copyright (C) 2023  Andrew P Berrien

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the [GNU General Public License](https://www.gnu.org/licenses/gpl.html) for more details.