Skip to content

A modern and interactive cryptocurrency dashboard built with Next.js

Notifications You must be signed in to change notification settings

jovenan/crypto-dash

Repository files navigation

Crypto Dashboard

A modern and interactive cryptocurrency dashboard built with Next.js, allowing users to track real-time prices, visualize market trends, and make informed investment decisions.

image image image

Features

  • 📊 Real-time cryptocurrency price tracking
  • 📈 Interactive price charts with historical data
  • 🔍 Advanced filtering and sorting capabilities
  • ⚡ Fast and efficient data loading
  • 🎨 Modern and clean user interface

Tech Stack

  • Next.js 14
  • TypeScript
  • Tailwind CSS
  • CoinGecko API

Getting Started

Prerequisites

  • Node.js 18.0 or later
  • npm or yarn package manager

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/crypto-dash.git
cd crypto-dash
  1. Install dependencies:
npm install
# or
yarn install
  1. Run the development server:
npm run dev
# or
yarn dev
  1. Open http://localhost:3000 in your browser to see the application.

Development Commands

Running Tests

# Run all tests
npm test
# or
yarn test

# Run tests in watch mode
npm run test:watch
# or
yarn test:watch

Linting

# Run ESLint to check for code issues
npm run lint
# or
yarn lint

Project Structure

src/
├── app/                    # Next.js app directory
│   ├── page.tsx           # Home page
│   ├── dashboard/         # Dashboard page
│   └── crypto/[id]/       # Individual coin details page
├── components/            # React components
│   ├── crypto-dashboard/  # Dashboard related components
│   ├── crypto-details/    # Coin details components
│   ├── ui/               # Reusable UI components
│   └── common/           # Common components
├── services/             # API services
│   ├── list-coins.ts     # Coin listing service
│   ├── get-coin.ts       # Individual coin service
│   └── get-coin-chart.ts # Chart data service
└── lib/                  # Utility functions
    └── utils.ts          # Helper functions

Contributing

We welcome contributions to improve the Crypto Dashboard! Here's how you can help:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add some amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

Development Guidelines

  • Follow the existing code style and structure
  • Write meaningful commit messages
  • Add tests for new features
  • Update documentation as needed
  • Ensure all tests pass before submitting a PR

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

About

A modern and interactive cryptocurrency dashboard built with Next.js

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages