CryptoTracker is a comprehensive cryptocurrency dashboard that allows users to track, compare, and analyze various cryptocurrencies in real-time. Built with React and Material-UI, this project offers a user-friendly interface for monitoring the crypto market.
- Real-time tracking of cryptocurrency prices
- Comparison of multiple cryptocurrencies
- Historical price charts (30-day view available)
- Grid view of top cryptocurrencies
- Mobile-friendly design
- Easy sharing functionality
The application's landing page with quick access to the dashboard.
The main dashboard displays current prices and 24-hour changes for selected cryptocurrencies.
A grid view comparing multiple cryptocurrencies with key metrics.
30-day price history chart for selected cryptocurrencies.
Various options for sharing the application with others.
Various options for sharing the application with others.
- React
- React Router
- Material-UI
- Chart.js
- Axios
- Framer Motion
- React Toastify
The project uses the CoinGecko API to fetch cryptocurrency data. Key functions include:
get100Coins
: Fetches top 100 cryptocurrenciesgetCoinData
: Retrieves detailed data for a specific coingetPrices
: Fetches historical price data for charting
After starting the development server, open your browser and navigate to http://localhost:3000
to use the application.
- Use the dashboard to view top cryptocurrencies
- Click on a cryptocurrency to view detailed information and charts
- Use the compare feature to analyze two cryptocurrencies side by side
- Add cryptocurrencies to your watchlist for quick access
- Toggle between dark and light modes for comfortable viewing
Follow these steps to set up the CryptoTracker project on your local machine:
-
Clone the repository Open your terminal and run the following command to clone the project:
-
Navigate to the project directory Change into the project directory:
-
Install Node.js and npm Ensure that you have Node.js and npm (Node Package Manager) installed on your system. You can download and install them from https://nodejs.org/. We recommend using Node.js version 14.x or later.
-
Install dependencies Install the project dependencies by running:This command will install all the necessary packages defined in the
package.json
file. -
Set up environment variables Create a
.env
file in the root directory of the project and add any necessary environment variables.Note: As of now, CoinGecko's public API doesn't require an API key, but this step is included for future-proofing. -
Start the development server Once the installation is complete, start the development server:This command runs the app in development mode.
-
View the application Open your web browser and visit http://localhost:3000 to view the application.
-
Build for production When you're ready to deploy the application, create a production build:This command builds the app for production to the
build
folder.
- If you encounter any issues with dependencies, try deleting the
node_modules
folder and thepackage-lock.json
file, then runnpm install
again. - Ensure that your Node.js version is compatible with the project. You can use a tool like nvm (Node Version Manager) to manage multiple Node.js versions.
- If you face any CORS issues while fetching data from the CoinGecko API, you might need to use a proxy server or browser extension to bypass CORS restrictions in development mode.
To update the project with the latest changes, pull the latest code from the repository:This will fetch the latest code and install any new dependencies.
For any additional help or information, please refer to the project's issue tracker on GitHub or contact the maintainers.
Contributions are welcome! Please feel free to submit a Pull Request.