Skip to content

mannadamay12/crypto-price-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Crypto Price Tracker

A real-time cryptocurrency price tracking application built with Next.js and documented with Docusaurus.

Project Structure

This repository contains two main parts:

  • /web-app: Next.js application for tracking cryptocurrency prices
  • /docs: Docusaurus documentation site

Quick Start

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn

Setup and Run Web App

# Clone the repository
git clone https://github.com/mannadamay12/crypto-price-tracker.git
cd crypto-price-tracker

# Install dependencies and run web app
cd web-app
npm install
npm run dev

The web app will be available at http://localhost:3000

Setup and Run Documentation

# From the project root
cd docs
npm install
npm run start

The documentation will be available at http://localhost:3000 You might need to choose another port if the web-app is live on PORT 3000

Features

  • Real-time cryptocurrency price tracking
  • Search functionality
  • Manual and automatic data refresh
  • Responsive design for mobile and desktop
  • Comprehensive documentation

Technologies Used

  • Next.js
  • TypeScript
  • Tailwind CSS
  • Zustand (State Management)
  • Axios
  • CoinGecko API
  • Docusaurus

Documentation

The documentation covers:

  • Project setup guide
  • API integration details
  • State management explanation
  • Challenges and solutions

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published