https://github.com/karamble/dcrpulse
Node Dashboard for Decred
https://github.com/karamble/dcrpulse
Last synced: about 1 month ago
JSON representation
Node Dashboard for Decred
- Host: GitHub
- URL: https://github.com/karamble/dcrpulse
- Owner: karamble
- License: isc
- Created: 2025-10-12T10:28:23.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-12-19T11:28:34.000Z (6 months ago)
- Last Synced: 2025-12-22T03:49:16.428Z (6 months ago)
- Language: TypeScript
- Size: 2.8 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dcrpulse
A modern, self-hosted dashboard for monitoring your Decred node, wallet, and blockchain in real-time.
## What is dcrpulse?
dcrpulse is a comprehensive dashboard that provides:
- **Node Dashboard**: Monitor your dcrd node performance, blockchain sync status, network peers, and mempool activity
- **Wallet Dashboard**: Track your wallet balances, transactions, staking tickets, and ticket pool statistics
- **Block Explorer**: Browse blocks, transactions, and addresses directly from your node
- **Treasury & Governance**: Monitor Decred treasury balance and TSpend proposals
All data comes from your local dcrd and dcrwallet instances via RPC - no third-party services required.
## Quick Start
### Prerequisites
- Docker and Docker Compose
- 10GB+ free disk space for blockchain data
### Launch
```bash
# 1. Clone the repository
git clone https://github.com//dcrpulse.git
cd dcrpulse
# 2. Set up environment
cp env.example .env
# Edit .env with your preferred RPC password
nano .env
# 3. Start all services
docker compose up -d
# 4. Access the dashboard
# Open http://localhost:8080 in your browser
```
The first run will sync the blockchain (takes 4-8 hours for mainnet). Monitor progress with:
```bash
docker compose logs -f dcrd
```
### Using Makefile
```bash
make start # Start all services
make stop # Stop all services
make logs # View logs
make status # Check status
```
For more commands: `make help`
## Documentation
Complete documentation is available in the [`docs/`](docs/) folder:
📚 **[Documentation Index](docs/readme.md)** - Start here
### Quick Links
**Getting Started**
- [First Steps](docs/getting-started/first-steps.md) - What to do after installation
- [Quick Start Guide](docs/getting-started/quick-start.md) - Detailed setup instructions
- [Environment Setup](docs/getting-started/environment-setup.md) - Configuration options
**Guides**
- [Wallet Operations](docs/guides/wallet-operations.md) - Import xpub, rescan, sync monitoring
- [Backup & Restore](docs/guides/backup-restore.md) - Protect your blockchain data
- [Troubleshooting](docs/guides/troubleshooting.md) - Common issues and solutions
**Features**
- [Node Dashboard](docs/features/node-dashboard.md) - Monitor your dcrd node
- [Wallet Dashboard](docs/features/wallet-dashboard.md) - Track balances and staking
- [Block Explorer](docs/features/block-explorer.md) - Browse blocks and transactions
**Deployment**
- [Docker Deployment](docs/deployment/docker-deployment.md) - Production setup
- [Monitoring Setup](docs/deployment/monitoring-setup.md) - Health checks and alerts
**Reference**
- [CLI Commands](docs/reference/cli-commands.md) - Makefile and Docker commands
- [Configuration](docs/setup/configuration.md) - All configuration options
## Project Structure
```
dcrpulse/
├── dashboard/ # Unified dashboard application
│ ├── cmd/ # Main application entry point
│ ├── internal/ # Go backend code
│ └── web/ # Frontend React app
├── dcrd/ # dcrd node Docker setup
├── dcrwallet/ # dcrwallet Docker setup
├── docs/ # Documentation
└── docker-compose.yml # Orchestration
```
See [dashboard/README.md](dashboard/README.md) for development and build instructions.
## Development
The dashboard combines backend and frontend into a single Go binary with embedded static files.
**Development mode** (hot reload):
```bash
# Terminal 1: Backend
cd dashboard
go run cmd/dcrpulse/main.go
# Terminal 2: Frontend
cd dashboard/web
npm install
npm run dev
```
Frontend dev server runs on http://localhost:3000 and proxies API calls to backend on http://localhost:8080.
**Production build**:
```bash
cd dashboard/web && npm run build
cd .. && go build ./cmd/dcrpulse
./dcrpulse # Serves on http://localhost:8080
```
## Support
For issues and questions:
- [GitHub Issues](https://github.com//dcrpulse/issues)
- [Decred Matrix](https://chat.decred.org)
- [Decred Discord](https://discord.gg/decred)
## License
ISC License - Part of the Decred community projects.
---
**Made with ❤️ for the Decred community**