Skip to content

BBariOxit/CoinFlow

Repository files navigation

CoinFlow

CoinFlow

A real-time crypto dashboard for tracking coins, viewing charts, and exploring market data.

Live Demo

Next.js React TypeScript TailwindCSS

Tech Stack

  • Framework: Next.js 16 (App Router)
  • Language: TypeScript
  • UI: Tailwind CSS v4 + shadcn/ui (Radix UI)
  • Data fetching: SWR
  • Charts: lightweight-charts (candlestick)
  • APIs: CoinGecko REST API
  • Realtime: OKX Public WebSocket

Key Features

  • Coin list with key metrics (price, 24h change, market cap)
  • Coin detail page with candlestick chart + market info
  • Realtime ticker / trades updates via WebSocket
  • Quick search modal with keyboard shortcut
  • Simple converter widget

Screenshots / GIF

Home

CoinFlow Home

All Coins

CoinFlow All Coins

Coin Details

CoinFlow Coin Details

Getting Started

Prerequisites

  • Node.js 18.18+ (recommended)
  • A CoinGecko API key

Installation

# 1) Clone
git clone <YOUR_REPO_URL>

# 2) Install dependencies
npm install

# 3) Create env file
cp .env.example .env.local

# 4) Start dev server
npm run dev

On Windows (PowerShell):

Copy-Item .env.example .env.local
npm install
npm run dev

Open http://localhost:3000

Optional (faster dev): npm run dev -- --turbo

Environment Variables

This project expects the following variables (see .env.example):

Name Required Description
COINGECKO_BASE_URL Yes CoinGecko REST base URL
COINGECKO_API_KEY Yes CoinGecko API key used in server requests

Scripts

  • npm run dev – start development server
  • npm run build – production build
  • npm run start – run production server
  • npm run lint – lint
  • npm run format – format with Prettier

Contributing

Issues and pull requests are welcome.

  • Fork the repo
  • Create a feature branch
  • Open a PR with a clear description and screenshots if UI changes

Acknowledgements

  • Data powered by CoinGecko
  • Realtime market streams from OKX Public WebSocket

About

A high-performance, real-time cryptocurrency analytics terminal featuring live market data, interactive charts, and instant price updates via WebSockets.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors