Skip to content

haodam/crypto-dashboard-backend

 
 

Repository files navigation

Crypto Dashboard Backend

A scalable microservices-based cryptocurrency dashboard backend system built with Go.

System Architecture

The system follows a microservices architecture pattern with the following key components:

  • API Gateway - Central entry point for all client requests
  • Microservices:
    • User Service - Authentication and user management
    • Market Data Service - Real-time crypto market data
    • Whale Tracking Service - Large transaction monitoring
    • Portfolio Service - User portfolio management
    • Notification Service - Real-time alerts and notifications

See detailed architecture diagrams

Getting Started

Prerequisites

  • Go 1.20+
  • Docker & Docker Compose
  • PostgreSQL 14+
  • Redis 6+
  • Kafka/RabbitMQ

Development Setup

  1. Clone the repository
git clone https://github.com/vietgs03/crypto-dashboard-backend
cd crypto-dashboard-backend
  1. Copy configuration files
cp configs/development/config.example.yaml configs/development/config.yaml
  1. Start dependencies with Docker Compose
docker-compose up -d

Project Structure

├── cmd/                 # Service entry points
├── internal/            # Private application code
├── pkg/                # Shared libraries
├── configs/            # Configuration files
├── docs/              # Documentation
└── tests/             # Tests

See complete structure

Development Guidelines

See our Development Guide for:

  • Code organization

  • Clean architecture principles

  • SOLID principles implementation

  • Testing guidelines

  • Error handling

Key Features

See Key Features for detailed feature list including:

  • Real-time market data

  • Whale activity tracking

  • Portfolio management

  • Alert system

  • Technical analysis tools

API Documentation

API documentation is available at:

Deployment

  1. Build Docker images
docker build -t crypto-dashboard-backend .
  1. Deploy to Kubernetes
kubectl apply -f configs/kubernetes/

Monitoring

  • Metrics: Prometheus (localhost:9090)

  • Dashboards: Grafana (localhost:3000)

  • Logs: ELK Stack

Contributing

  1. Follow Development Guidelines

  2. Create feature branch

  3. Make changes

  4. Submit PR with description

Document

Architecture

Development

Features

Operations

License

MIT License

Contact For support or queries, contact the team at: team@your-domain.com


This README provides a comprehensive overview of the project while linking to the detailed documentation available in the workspace. It follows best practices for open source projects and includes all necessary information for developers to get started.
This README provides a comprehensive overview of the project while linking to the detailed documentation available in the workspace. It follows best practices for open source projects and includes all necessary information for developers to get started.

About

crypto-dashboard-backend

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 97.7%
  • Makefile 1.8%
  • Dockerfile 0.5%