Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sterrenb/flutterhole
A third party Android application for the Pi-Hole® dashboard.
https://github.com/sterrenb/flutterhole
android dart flutter mobile pi-hole raspberry-pi
Last synced: 3 days ago
JSON representation
A third party Android application for the Pi-Hole® dashboard.
- Host: GitHub
- URL: https://github.com/sterrenb/flutterhole
- Owner: sterrenb
- License: mit
- Archived: true
- Created: 2019-01-20T21:09:43.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-09T15:02:38.000Z (over 1 year ago)
- Last Synced: 2024-05-19T12:10:12.452Z (8 months ago)
- Topics: android, dart, flutter, mobile, pi-hole, raspberry-pi
- Language: Dart
- Homepage: https://play.google.com/store/apps/details?id=sterrenburg.github.flutterhole
- Size: 2.51 MB
- Stars: 402
- Watchers: 13
- Forks: 27
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# FlutterHole #
[](https://codemagic.io/apps/5c659ea9c49a5000198d45f9/5eca30b4261f343c0e2417c4/latest_build)
[](https://coveralls.io/github/sterrenburg/flutterhole?branch=master)
[](https://opensource.org/licenses/MIT)
[](https://flutter.io)
FlutterHole is a free third party Android application for interacting with your Pi-Hole® server.
> **Note**: Currently archived. Check the [`web` branch](https://github.com/sterrenburg/flutterhole/tree/web) to check the archived beta release.
[
](https://play.google.com/store/apps/details?id=sterrenburg.github.flutterhole)
## Features ##
- **Quick enable/disable:** Toggle your Pi-hole from your home screen with a single tap.
- **Multiple configurations:** Easily switch between every Pi-hole that you have access to.
- **Summary overview:** View top clients and the top used domains.
- **Query log:** Inspect & search your Pi-hole queries.
## Development ##
FlutterHole is developed using [Android Studio](https://developer.android.com/studio), which offers a complete, integrated IDE experience for Flutter.
Testing is done using a local Pi-hole installation on an internal network. Due to this, support for other network setups relies heavily on user feedback.
If you want to improve the network support for FlutterHole by testing against your own setups, you can build the app locally and debug any issues.
### Getting Started ###
After cloning this repository, perform the following steps before building your project.
All snippets assume your initial working directory is the root of the project.
#### Generate a debug signing key ####
Skip the questions, and confirm with `yes`.
```shell script
#!/bin/bash
cd android/app
keytool -genkey -v -keystore keystore.jks -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000
```
#### Create a properties file for the signing key ####
```shell script
#!/bin/bash
cd android
touch key.properties
```
After creating the file, populate it with plaintext describing the debug key.
```
storePassword=android
keyPassword=android
keyAlias=androiddebugkey
storeFile=keystore.jks
```
#### Generate the icon assets ####
```shell script
#!/bin/bash
flutter pub get
flutter pub run flutter_launcher_icons:main
```
#### Generate code ####
To generate `freezed` classes, `injectable` injections etc.:
```shell script
flutter pub run build_runner build --delete-conflicting-outputs
```
Or, build continuously:
```shell script
flutter pub run build_runner watch --delete-conflicting-outputs
```
You can now build and run the app on either an emulator or a physical device using `flutter run`.
### Testing ###
To run the default integration test:
```shell script
flutter drive --target=test_driver/app.dart
```
## API ##
This application interacts with the [Pi-hole PHP API](https://discourse.pi-hole.net/t/pi-hole-api/1863).
A new API is in the works from the Pi-hole team. For progress, check the [pull request on GitHub](https://github.com/pi-hole/FTL/pull/659).