# harshsri28/crypto-exchange architecture

> Architecture diagram of the GitHub repository harshsri28/crypto-exchange, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/harshsri28/crypto-exchange
- Repository: https://github.com/harshsri28/crypto-exchange

## Overview

##### Project type and purpose
- This is a stateless backend microservice (“Crypto API”) built on Node.js/Express.
- Purpose: expose two HTTP endpoints (/getTop100 and /currencyConvertor) that fetch data from an external cryptocurrency data provider (e.g., CoinGecko) and return results to clients.

##### File structure
- config/
– development.json: environment-specific settings (e.g., API URLs, ports).
– winstonConfig.js: centralized logging setup using Winston.
- index.js
– Entry point: loads configuration, instantiates Express app, applies middleware (logger, JSON parsing), mounts routes, and starts HTTP server.
- src/routes.js
– Defines Express routes and maps HTTP methods + paths to controller functions.
- src/controllers/cryptoController.js
– Controller layer: validates request payload, calls service layer, and formats HTTP responses.
- src/services/cryptoService.js
– Business‐logic layer: constructs and issues HTTP requests to the external crypto API, processes raw data, and returns normalized objects.
- src/utils/constants.js
– Shared constants (e.g., endpoint paths, default currency codes).
- package.json / package-lock.json
– Lists dependencies (Express, Axios or node-fetch, Winston, etc.) and scripts.

##### Extract architecture hints from README
- Two REST GET endpoints with JSON requests & responses.
- No internal database—data is proxied/transformed from an external service.
- Logging and environment configuration are central cross‐cutting concerns.

##### Key reminders
- Be thorough: include every major piece (index.js startup, config injection, routes, controllers, services, external API).
- Use consistent naming from the codebase (e.g., “cryptoController”, “cryptoService”).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    Client["Clients<br/>(Postman, Frontend, Other Services)"]:::external

    %% API Gateway
    APIGateway["API Gateway<br/>(index.js)"]:::gateway

    %% Routing Layer
    Router["Router Layer<br/>(src/routes.js)"]:::router

    %% Controller Layer
    Controller["Controller Layer<br/>(cryptoController.js)"]:::controller

    %% Service Layer
    Service["Service Layer<br/>(cryptoService.js)"]:::service

    %% External API
    ExternalAPI["External Crypto Data Provider<br/>(e.g., CoinGecko REST API)"]:::external

    %% Cross-cutting Modules
    subgraph "Cross-cutting Modules"
        ConfigDev["Environment Config<br/>(config/development.json)"]:::crosscut
        Logger["Logging Setup<br/>(config/winstonConfig.js)"]:::crosscut
        Constants["Utility Constants<br/>(src/utils/constants.js)"]:::crosscut
    end

    %% Dependency Declarations & Scripts
    subgraph "Project Dependencies"
        Package["package.json"]:::deps
        PackageLock["package-lock.json"]:::deps
    end

    %% Flow
    Client -->|"HTTP GET /getTop100<br/>or /currencyConvertor"| APIGateway
    APIGateway -->|"mounts routes"| Router
    Router -->|"invoke functions"| Controller
    Controller -->|"call service methods"| Service
    Service -->|"HTTP request"| ExternalAPI
    ExternalAPI -->|"JSON response"| Service
    Service -->|"normalized data"| Controller
    Controller -->|"JSON response"| APIGateway
    APIGateway -->|"HTTP response"| Client

    %% Cross-cutting injections
    ConfigDev --> APIGateway
    Logger --> APIGateway
    Constants --> Router
    Constants --> Controller
    Constants --> Service

    %% Click Events
    click APIGateway "https://github.com/harshsri28/crypto-exchange/blob/main/index.js"
    click ConfigDev "https://github.com/harshsri28/crypto-exchange/blob/main/config/development.json"
    click Logger "https://github.com/harshsri28/crypto-exchange/blob/main/config/winstonConfig.js"
    click Router "https://github.com/harshsri28/crypto-exchange/blob/main/src/routes.js"
    click Controller "https://github.com/harshsri28/crypto-exchange/blob/main/src/controllers/cryptoController.js"
    click Service "https://github.com/harshsri28/crypto-exchange/blob/main/src/services/cryptoService.js"
    click Constants "https://github.com/harshsri28/crypto-exchange/blob/main/src/utils/constants.js"
    click Package "https://github.com/harshsri28/crypto-exchange/blob/main/package.json"
    click PackageLock "https://github.com/harshsri28/crypto-exchange/blob/main/package-lock.json"

    %% Styles
    classDef gateway fill:#D0E6FF,stroke:#0366d6,stroke-width:1px
    classDef router fill:#E6F0FF,stroke:#0366d6,stroke-width:1px
    classDef controller fill:#E6FFE6,stroke:#028A0F,stroke-width:1px
    classDef service fill:#E6FFE6,stroke:#028A0F,stroke-width:1px
    classDef external fill:#FFF5E6,stroke:#D38300,stroke-width:1px
    classDef crosscut fill:#FFF9C4,stroke:#F0AD4E,stroke-width:1px
    classDef deps fill:#F2F2F2,stroke:#AAAAAA,stroke-width:1px
```
