CoinSight is a dynamic cryptocurrency tracking application that allows users to monitor and analyze real-time crypto market data. Leveraging Polygon.io API and Groq's AI capabilities, CoinSight provides insightful financial reports and recommendations for various cryptocurrencies.
- Features
- Installation
- Usage
- Technologies Used
- Project Structure
- Contributing
- License
- Contact
- Real-Time Data Fetching: Get the latest cryptocurrency data from Polygon.io.
- AI-Powered Reports: Generate financial reports using Groq's AI.
- Dynamic Visualization: Display data and reports side by side.
- User-Friendly Interface: Easy navigation and interaction for a seamless experience.
- Clone the repository:
- git clone https://github.com/gbengaoluwadahunsi/coinSight.git
- cd coinSight
- Install dependencies:
- npm install
- Set up environment variables:
- VITE_POLYGON_API_KEY=your_polygon_api_key
- VITE_GROQ_API_KEY=your_groq_api_key
- Run the application:
- npm run dev
- Select Cryptocurrency Tickers:
- Use the dropdown menu to select one or more cryptocurrency tickers.
- Click "Add Ticker" to add the selected ticker to the list.
- Generate Report:
- Click "Generate Report" to fetch the latest data and generate a financial report.
- The app will display the data and the AI-generated report side by side.
- Frontend: React, Vite
- Styling: Tailwind CSS
- API Integration: Polygon.io, Groq AI
- Build Tool: Vite
- I welcome contributions to CoinSight! Please follow these steps:
-
Fork the repository.
-
Create a new branch for your feature or bug fix: git checkout -b feature-name
-
Commit your changes: git commit -m 'Add new feature'
-
Push to the branch: git push origin feature-name
-
Create a pull request.
- This project is licensed under the MIT License. See the LICENSE file for details.
- For any questions or suggestions, feel free to reach out:
Email:[email protected] GitHub: https://github.com/gbengaoluwadahunsi