https://github.com/delphian/tronrelic
Open-source platform for TRON on-chain research and analytics. Monitor blockchain activity, track whale movements, compare energy markets, and explore the chain with extensible plugins.
https://github.com/delphian/tronrelic
cyrpto tron-protocol
Last synced: 4 months ago
JSON representation
Open-source platform for TRON on-chain research and analytics. Monitor blockchain activity, track whale movements, compare energy markets, and explore the chain with extensible plugins.
- Host: GitHub
- URL: https://github.com/delphian/tronrelic
- Owner: delphian
- License: other
- Created: 2025-10-13T00:10:34.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-12-29T08:20:08.000Z (5 months ago)
- Last Synced: 2025-12-29T09:58:37.674Z (5 months ago)
- Topics: cyrpto, tron-protocol
- Language: TypeScript
- Homepage: https://tronrelic.com
- Size: 3.88 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Agents: AGENTS.md
- Cla: .github/CLA.md
Awesome Lists containing this project
README
# TronRelic
Open-source TRON blockchain analytics platform with real-time monitoring, whale tracking, and extensible plugins.
## Quick Start
```bash
cp .env.example .env
openssl rand -hex 32 # Add to ADMIN_API_TOKEN in .env
# Add TronGrid API keys to .env (get free keys at https://www.trongrid.io/)
npm install
npm run dev
```
**URLs:** Frontend http://localhost:3000 | API http://localhost:4000 | Admin http://localhost:3000/system
**Stop:** Press Ctrl+C to stop dev servers. Run `npm run stop` to stop database containers.
**Requirements:** Node.js 20+, Docker, TronGrid API keys
## License
AGPL-3.0-or-later with plugin exception. Third-party plugins may use any license. See [LICENSE](LICENSE) for details.
## Documentation
**STOP. Before working on any topic below, you MUST click through and read the associated documentation.** These documents contain architectural decisions, required patterns, and constraints that are non-negotiable. Skipping them leads to rejected code, security vulnerabilities, and wasted effort.
### Core
| Document | Purpose |
|----------|---------|
| [Documentation Standards](docs/documentation.md) | Writing style, structure, cross-references |
| [Environment Variables](docs/environment.md) | All backend/frontend configuration options |
### System Architecture
| Document | Purpose |
|----------|---------|
| [System Overview](docs/system/system.md) | Blockchain sync, scheduler, observers, metrics |
| [Backend Modules](docs/system/system-modules.md) | IModule interface, init/run lifecycle, DI |
| [Database Access](docs/system/system-database.md) | IDatabaseService abstraction, three-tier access |
| [System API Reference](docs/system/system-api.md) | 16+ admin endpoints, authentication |
| [Blockchain Sync](docs/system/system-blockchain-sync-architecture.md) | Block retrieval, enrichment, observer notification |
| [System Dashboard](docs/system/system-dashboard.md) | /system UI, job control, monitoring |
| [Database Migrations](docs/system/system-database-migrations.md) | Schema evolution, transaction support |
| [Logging System](docs/system/system-logging.md) | Pino, MongoDB persistence, log queries |
| [Menu Module](docs/system/system-modules-menu.md) | Navigation management, plugin integration |
| [Pages Module](docs/system/system-modules-pages.md) | CMS, markdown, file uploads |
| [User Module](docs/system/system-modules-user.md) | Identity, wallet linking, preferences |
| [Runtime Configuration](docs/system/system-runtime-config.md) | Universal Docker images, SITE_URL |
| [Scheduler Operations](docs/system/system-scheduler-operations.md) | Job management, cron, troubleshooting |
| [Testing Framework](docs/system/system-testing.md) | Vitest, Mongoose mocks, test isolation |
### Plugin Development
| Document | Purpose |
|----------|---------|
| [Plugin Overview](docs/plugins/plugins.md) | Lifecycle, structure, capabilities |
| [API Registration](docs/plugins/plugins-api-registration.md) | REST routes, middleware, admin endpoints |
| [Blockchain Observers](docs/plugins/plugins-blockchain-observers.md) | Transaction processing, subscriptions |
| [Frontend Context](docs/plugins/plugins-frontend-context.md) | API client, WebSocket, toasts, modals |
| [Page Registration](docs/plugins/plugins-page-registration.md) | Routes, dynamic segments, SSR |
| [Plugin Architecture](docs/plugins/plugins-system-architecture.md) | Loader, manifests, error isolation |
| [WebSocket Subscriptions](docs/plugins/plugins-websocket-subscriptions.md) | Real-time events, rooms, namespacing |
| [Widget Zones](docs/plugins/plugins-widget-zones.md) | Injecting UI into core pages |
### Frontend Development
| Document | Purpose |
|----------|---------|
| [Frontend Overview](docs/frontend/frontend.md) | Next.js 14, modules, SSR + Live Updates |
| [Frontend Architecture](docs/frontend/frontend-architecture.md) | Directory structure, modules vs features |
| [React Components](docs/frontend/react/react.md) | Server/client components, hooks, context |
| [UI System](docs/frontend/ui/ui.md) | Design tokens, SCSS Modules, layout |
| [Component Styling](docs/frontend/ui/ui-component-styling.md) | CSS variables, container queries |
| [Design Tokens](docs/frontend/ui/ui-design-token-layers.md) | Primitives, semantic tokens, theming |
### TRON Blockchain
| Document | Purpose |
|----------|---------|
| [TRON Overview](docs/tron/tron.md) | Energy system, transactions, parameters |
| [Chain Parameters](docs/tron/tron-chain-parameters.md) | Service, conversions, caching |
**This is not optional.** Load and read the relevant documents before writing code. The patterns exist because they were learned through costly mistakes. Respect that investment.