Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fusion44/blitz_gui
A UI interface for RaspiBlitz focused on Raspberry PI screens
https://github.com/fusion44/blitz_gui
bitcoin dart flutter lightning-network raspiblitz touchscreen
Last synced: about 2 months ago
JSON representation
A UI interface for RaspiBlitz focused on Raspberry PI screens
- Host: GitHub
- URL: https://github.com/fusion44/blitz_gui
- Owner: fusion44
- License: mit
- Created: 2021-04-05T18:00:01.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T18:42:52.000Z (9 months ago)
- Last Synced: 2024-04-05T19:43:17.838Z (9 months ago)
- Topics: bitcoin, dart, flutter, lightning-network, raspiblitz, touchscreen
- Language: Dart
- Homepage:
- Size: 3.46 MB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blitz GUI
This repository contains apps and libraries related to the Blitz GUI project. This a frontend application to be used with the [blitz_api](https://github.com/fusion44/blitz_api) backend.
The user interface is realized using the [Flutter](https://www.flutter.dev) framework and [flutter-pi](https://github.com/ardera/flutter-pi) to make it run natively on a Raspberry PI.
## Disclaimer
This is very much under development and might contain serious bugs. Don't use it in production, yet.
## Develop
### Repository information
This is a monorepo which contains multiple apps and libraries. The shell app in `lib/main.dart` currently does nothing but exit when run. Currently there are two apps available:* `setup_app`: An app to help setting up a new RaspiBlitz. Located in `packages/apps/setup_app`
* `blitz_app`: The main RaspiBlitz Desktop app. Located in `packages/apps/setup_app`### Dependencies
* **Blitz API**
To develop this application, make sure you have an instance of [blitz_api](https://github.com/fusion44/blitz_api) running and reachable.
* **Flutter**
If you are new to Flutter follow the install instructions for your OS: [Flutter Docs](https://flutter.dev/docs/get-started/install).
> :information_source: Flutter has opt-out analytics which can be disabled by running `flutter config --no-analytics`.
### Run the apps
* Run an app locally:
* With make: `make run-linux`
* Use `make` without any arguments to print a help message with all available options
* With flutter directly `flutter run -d linux` (or windows, or macosx, or chrome). Make sure to run this not in the base folder but in each apps specific folder in `packages/apps/app_name`## Contribute
If you find any issues, please report them via the [Github issue tracker](https://github.com/fusion44/blitz_api/issues).
If you are interested in helping developing the software, you are very welcome to submit ideas to the issue tracker and help by opening pull requests.## LICENSE
MIT - See the [LICENSE](LICENSE) file.