GodsEye (English)

For Chinese version please see README-zh.

Overview

BFMeta on-chain data analytics & monitoring suite with Angular/Ionic frontend and Koa backend; supports data import, metrics visualization, alerts, and multi-platform packaging.

Usage

1. Configure config/baseConfig.json: set super admin, mongoDb.user, mail; adjust ports; place privatekey.pem and certificate.pem in ssl/ when enabling HTTPS.
2. Start:
   • Windows: double-click godeyes.exe
   • Linux: run ./godeyes Success when server start! appears without errors.
3. Dev mode: npm run start (frontend + backend) or run npm run start:server / start:client separately.
4. Production build: npm run prod:win / prod:linux; append :zip to create distributables.
5. Chain data import:
   • chainData/ is auto-created after first run.
   • Export node data via mongodump, zip the BSON/JSON folder, name it bnid_chainName_magic.zip (e.g., c_bfchain_LE4EE.zip).
   • Place the zip into chainData/; it will be deleted after import—keep your own backup.

Contribution (brief)

• Keep front/back separation: business logic in Koa services; frontend components stay presentation/interaction focused (SRP/KISS).
• TS strict; avoid any/@ts-ignore; share utilities in server/common or shared services to stay DRY.
• Update frontend calls and bilingual copy when adding APIs/events; document important config in README or conf comments.
• Run npm run build:server and npm run build:client; before committing, perform at least one minimal npm run prod verification.