gobitfly / eth2-beaconchain-explorer-app

Beaconchain Dashboard is an open source ethereum validator performance tracker app for Android and iOS.
https://beaconcha.in/mobile
GNU General Public License v3.0
252 stars 75 forks source link

[beaconchain Dashboard](https://beaconcha.in/mobile)
Build

Beaconchain Dashboard App

Beaconchain Dashboard is an open source ethereum and gnosis validator performance tracker app for Android and iOS. It utilizes the beaconcha.in API.

Get it on Google Play Get it App Store

About

Beaconchain Dashboard is an Angular app written in Typescript, HTML & CSS. It utilizes the Ionic framework for mobile components and Ionic Capacitor as bridge for native code.

Features

Device support

Development

Getting started

  1. Clone repo
  2. Install dependencies
    npm install -g @ionic/cli native-run cordova-res
    npm i

NOTE: You need to provide your own google-services.json for Android and GoogleService-Info.plist for iOS.

Browser

To run the app in your browser, simply use

npm run-script serve

to start a local webserver with livereload enabled.

Android

Prerequisites

For Linux Users: Open capacitor.config.json (in the root of the project) and adapt the paths for the linuxAndroidStudioPath variable to reflect your local setup.

Build the the app at least once before proceeding:

ionic build

Livereload

Make sure port 8100 is accessible on your computer and use the following command to run a livereload server

ionic cap run android --livereload --external --host=192.168.1.64 --disableHostCheck --configuration=development

Adapt the --host param to match your computers IP.

Build for production

npm run-script build-android-for-production

Install via Android Studio

To install the app on a real device, follow this guide: https://developer.android.com/studio/run/device

Or to run it in an emulator, follow up here: https://developer.android.com/studio/run/emulator

iOS

Prerequisites

Build the the app at least once before proceeding:

ionic build

Livereload

Make sure port 8100 is accessible on your mac and use the following command to run a livereload server

ionic cap run ios --livereload --external --host=192.168.1.64 --disableHostCheck --configuration=development

Adapt the --host param to match your macs IP.

Build for production

npm run-script build-ios-for-production

Best Practices

License

This project is licensed under GPLv3. LICENSE