Get Started in 3 Steps
This guide will help you go from installation to using CryptoDash’s core features in just a few minutes.Start the Development Server
If you haven’t already, start the development server:Open your browser and navigate to
http://localhost:5173Explore the Dashboard
The dashboard is your central hub for monitoring cryptocurrency markets:
- Summary Cards: View total balance, 24h change, profit/loss, and total assets
- Performance Chart: Interactive Bitcoin price chart with hover tooltips
- Market Table: Top cryptocurrencies with real-time prices and 7-day sparklines
Navigate the Application
Use the sidebar to explore different sections:
- Dashboard: Overview of your portfolio and market highlights
- Portfolio: Manage your crypto holdings
- Market: Browse and search 2,500+ cryptocurrencies
- Analysis: Analyze volatility and compare assets
- Transactions: View transaction history
- Settings: Customize theme and language preferences
Understanding the Application Structure
CryptoDash is built with React and follows a component-based architecture. Here’s how the core pieces work together:Entry Point
The application starts insrc/main.jsx, which sets up the React app with necessary providers:
src/main.jsx
The app uses Context API for global state management.
SettingsProvider manages theme and language, while ToastProvider handles notifications.API Configuration
CryptoDash uses Axios to communicate with the CoinGecko API. The API client is configured insrc/api/axios.js:
src/api/axios.js
Core Features Walkthrough
Theme Switching (Dark/Light Mode)
CryptoDash includes a sophisticated theme system managed by the Settings Context:src/contexts/SettingsContext.jsx (excerpt)
Example Component
Using the Dashboard
View Market Overview
The dashboard displays 4 key metrics at the top:
- Total Balance: Sum of all portfolio holdings
- 24h Change: Percentage change in the last 24 hours
- Profit/Loss: Total profit or loss from your positions
- Total Assets: Number of different cryptocurrencies you own
Interact with the Price Chart
The performance chart shows Bitcoin’s price over time:
- Hover: Move your mouse over the chart to see exact prices at specific times
- Tooltips: A tooltip appears showing the date and price
- Responsive: The chart adapts to different screen sizes
Managing Your Portfolio
Add Assets
Click the Add Asset button to add a cryptocurrency to your portfolio:
- Select the cryptocurrency from the dropdown
- Enter the amount you own
- Enter the purchase price (optional)
- Click Add to save
View Performance
The portfolio page displays:
- 30-day Performance Chart: Visual representation of your portfolio value over time
- Asset Allocation: Pie chart showing distribution of holdings
- Strongest Performers: List of assets with the highest gains
- Total Value: Current value of your entire portfolio
Exploring the Market
The Market page lets you browse and search over 2,500 cryptocurrencies:Apply Filters
Filter cryptocurrencies by:
- Market Cap: Sort by market capitalization
- Volume: Filter by 24h trading volume
- 24h Change: Show only gainers or losers
Customizing Settings
Change Theme
Toggle between dark and light mode:
- Click the theme toggle switch
- The change applies instantly
- Your preference is saved to localStorage
Mobile Experience
CryptoDash is fully responsive and optimized for mobile devices:- Hamburger Menu: The sidebar collapses into a hamburger menu on mobile
- Touch-Friendly: All buttons and interactive elements are sized for touch
- Horizontal Scroll: Tables scroll horizontally on small screens
- Optimized Charts: Charts adapt to mobile screen sizes
To test mobile view during development, use your browser’s device emulation tools (F12 → Toggle Device Toolbar in Chrome).
Common Tasks
Adding a New Page
To add a new page to CryptoDash:- Create a new component in
src/pages/ - Add the route to
src/router/AppRouter.jsx - Update navigation in
src/constants/navigation.js - Add translations in
src/i18n/translations.js
Making API Calls
Use the configured API client for all API calls:Example API Call
Using Custom Hooks
CryptoDash provides several custom hooks for common tasks:Using Custom Hooks
Development Tips
Next Steps
Now that you’re familiar with CryptoDash basics, you can:Customize Components
Explore the
src/components/ directory to modify existing components or create new onesAdd Features
Build new features using the established patterns for API calls, state management, and routing
Deploy to Production
Create a production build and deploy to services like Vercel, Netlify, or GitHub Pages
Explore the API
Check out the CoinGecko API docs to discover additional endpoints
Getting Help
If you encounter issues:- Check the browser console for error messages
- Review the troubleshooting section in the Installation Guide
- Ensure all dependencies are properly installed
- Verify that the CoinGecko API is accessible from your network
