hyperrtls / hyperrtls-dashboard

Dashboard for HyperRTLS tracking system

HyperRTLS Dashboard

Dashboard application is an example of a third-party web application using the API exposed by the HyperRTLS system. It enables visualization of a positioning network located in a residential space. The application displays the positions of tags on a three-dimensional model of a room.

Features

• Server-Side Rendering (assets details, emotion cache)
• Live updates using Server-Sent Events
• Loading GLB 3D Models
• Light/dark mode toggle based on system preference
• Fullscreen mode
• Performance monitoring

Installation and running

Cloning repository

git clone https://github.com/HyperRTLS/hyperrtls-dashboard.git

Make sure to tell the editor of your choice to use the workspace TypeScript version. When in doubt, check the following guide on Editor setup for Yarn.

Environment variables

To run this project, you will need to set the following environment variables:

SERVER_API_URL - server side HyperRTLS backend URL

CLIENT_API_URL - client side HyperRTLS backend URL

Building dependencies

Despite using Yarn's Zero-Installs, you might need to build some of the dependencies prior to running the project. Simply type yarn and everything should be automatically set up.

Running the project

yarn dev

By default, the dashboard development server listens on port 3000. You can change that behavior in package.json file or call the script directly:

yarn next dev -p <port_number>

Creating an optimized production build

yarn build

Running production build

yarn start

By default, the dashboard production server listens on port 3000. You can change that behavior in package.json file or call the script directly:

yarn next start -p <port_number>

Docker support

Docker image is available at ghcr.io repository.

You can also build your own image based on provided Dockerfile.

Authors

• Sebastian Szczepański @sszczep
• Aleksander Wójtowicz @anuar2k

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

hyperrtls-dashboard's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update docker/build-push-action digest to ca052bb
• chore(deps): update docker/login-action digest to 0d4c9c5
• chore(deps): update docker/metadata-action digest to f7b4ed1
• chore(deps): update node.js to 66c7d98
• chore(deps): update all non-major dependencies (@emotion/cache, @emotion/react, @emotion/server, @emotion/styled, @mui/icons-material, @mui/material, @react-three/drei, @react-three/fiber, @types/node, @types/react, @types/react-dom, @types/three, @typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint, eslint-config-next, eslint-config-prettier, prettier, react, react-dom, three, typescript, yarn)
• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-node action to v4
• chore(deps): update dependency @types/node to v20
• chore(deps): update dependency @typescript-eslint/eslint-plugin to v7
• chore(deps): update dependency @typescript-eslint/parser to v7
• chore(deps): update dependency eslint to v9
• chore(deps): update dependency eslint-config-next to v14
• chore(deps): update dependency eslint-config-prettier to v9
• chore(deps): update dependency eslint-plugin-prettier to v5
• chore(deps): update dependency prettier to v3
• chore(deps): update docker/setup-buildx-action action to v3
• chore(deps): update docker/setup-qemu-action action to v3
• chore(deps): update yarn to v4
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

dockerfile

Dockerfile

• node lts-alpine@sha256:47d97b93629d9461d64197773966cc49081cf4463b1b07de5a38b6bd5acfbe9d
• node lts-alpine@sha256:47d97b93629d9461d64197773966cc49081cf4463b1b07de5a38b6bd5acfbe9d

github-actions

.github/workflows/main.yml

• actions/checkout v3
• actions/setup-node v3
• actions/checkout v3
• docker/setup-qemu-action v2
• docker/setup-buildx-action v2
• docker/login-action 65b78e6e13532edd9afa3aa52ac7964289d1a9c1
• docker/metadata-action 3f6690a76cbcbe44da6bac853d66df365ab3af27
• docker/build-push-action 817ed59f97d2974e2c1d92f170242f52fd3feae4

npm

.yarn/sdks/eslint/package.json

.yarn/sdks/prettier/package.json

.yarn/sdks/typescript/package.json

package.json

• @emotion/cache 11.10.7
• @emotion/react 11.10.6
• @emotion/server 11.10.0
• @emotion/styled 11.10.6
• @mui/icons-material 5.11.16
• @mui/material 5.11.16
• @react-three/drei 9.50.3
• @react-three/fiber 8.12.0
• next 13.3.0
• react 18.2.0
• react-dom 18.2.0
• three 0.151.3
• @types/node 18.15.11
• @types/react 18.0.33
• @types/react-dom 18.0.11
• @types/three 0.150.1
• @typescript-eslint/eslint-plugin 5.57.1
• @typescript-eslint/parser 5.57.1
• eslint 8.38.0
• eslint-config-next 13.3.0
• eslint-config-prettier 8.8.0
• eslint-plugin-prettier 4.2.1
• prettier 2.8.7
• typescript 5.0.4
• yarn 3.5.0

---

• Check this box to trigger a request for Renovate to run again on this repository