README
¶
Ki - Native Dynamic Dashboard
About
What is this?
This is a natively compiled, hardware accelerated dashboard built in Go with Raylib. Live data is pulled to the Ki Client through the Ki Server which essentially acts as a data pipeline, see server.go for example.
Platform Support
| Windows | Linux | MacOS | Android | iOS | Web |
|---|---|---|---|---|---|
| ✅ | ✅ | ✅ | ❓ | ❓ | ❌ |
I haven't got the time to test Android and iOS. It seems to be possible to run Go on mobile, and WebAssembly is officially supported. Raylib uses Emcripten for WebAssembly target which is not supported by Go's cgo compiler, but raylib-go has an example for android here.
Getting Started
Installation
Download the repository
git clone https://github.com/neonnetwork/ki.git
cd ki
Install the dependencies
go get -u ./cmd/*
go mod tidy
Usage
Start the Ki Server
go run ./cmd/server
Start the Ki Client
export KI_SETUP=BINANCE # choose data setup
go run ./cmd/ki
You can customize the setup to include your own data sources.
Contributing
Issues and pull requests are welcome. Here are suggestions for changes:
- Proper documentation
- Support for config files
- Pipelines for building executables
- Performance improvements
- Automated tests
Credits
- https://github.com/raysan5/raylib Epic project for cross-platform 2D and 3D graphics
- https://github.com/gen2brain/raylib-go Go bindings for Raylib
License
Distributed under the MIT License. See LICENSE.txt for more information
Directories