https://github.com/techplexengineer/bionicdash
Better Dashboard for FRC
https://github.com/techplexengineer/bionicdash
Last synced: about 1 year ago
JSON representation
Better Dashboard for FRC
- Host: GitHub
- URL: https://github.com/techplexengineer/bionicdash
- Owner: TechplexEngineer
- Created: 2021-06-03T01:28:07.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-05-22T03:58:35.000Z (almost 4 years ago)
- Last Synced: 2025-01-07T23:36:27.650Z (about 1 year ago)
- Language: Svelte
- Size: 986 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
BionicDash
==========
Minimal proof of concept cross platform network tables client
## Goals
- Make debugging complex robot code easier (Programmers best friend)
- Low memory footprint
- support large amounts of frequently changing data
- Cleaner apis for robot code driven layouts
- Robust graphing/charting of timeseries data with export capability
- recording/playback of timeseries data
## Non-Goals
- Support all features of Shuffleboard
- Support camera streams
- Features needed for competitions
## For Developers
BionicDash is built using the Wails framework which provides APIs to make working
with native webviews easier and backend to frontend data synchronization easier.
The frontend is written in javascript using the Svelte framework.
### Getting Setup
To do development on BionicDash a number of dependencies must be installed:
- Golang
- Recommend go 1.16 or greater (Debian repos have 1.13 which is starting to get old) Download from https://golang.org/dl/
- Wails
- `go install github.com/wailsapp/wails/v2/cmd/wails@latest`
- See: https://wails.io/docs/gettingstarted/installation
- Node/NPM
- NodeJs v14
### Building for Release
To build a redistributable, production mode package, use `wails build`.
https://wails.io/docs/reference/cli#build
### Code Style
Go code should be run through `go fmt`
Shell scripts should pass `shellcheck` without errors
Code should pass the default suite of linters from golangci-lint.
The Github Actions CI is automatically running the linter. @todo
[Directions here to install the linter locally](https://golangci-lint.run/usage/install/).
`$ golangci-lint` run can be used to run the linter locally.