A React-based Chatbot User Interface designed for cryptocurrency-related tasks. It offers real-time communication, PDF viewing for crypto-related documents (e.g., whitepapers), and a clean design built with Ant Design, PDF.js, and WebSocket hooks.
- Crypto-Focused Chatbot Interface: Engage with a chatbot specifically customized for cryptocurrency tasks like price tracking, updates, FAQs, or educational material.
- PDF Viewer: Easily view cryptocurrency whitepapers, reports, or guides using PDF.js library.
- Ant Design UI: Elegant and intuitive user interface with Ant Design components.
- Real-Time Communication: Real-time message exchange powered by WebSocket hooks.
- Node.js (v16 or later): Install Node.js from nodejs.org.
- Chatbot Backend API: The chatbot interacts with a backend API. Ensure the backend service handling the crypto-related chatbot data is up and running.
Follow these steps to set up and test the Crypto Chatbot UI locally:
git clone https://github.com/softdev629/crypto-ai-client.git
cd crypto-ai-client
npm install
Ensure the chatbot API backend (which provides cryptocurrency-related answers and functionality) is properly configured and running. Follow the backend repository setup instructions for details.
If you're testing locally, ensure your backend listens on localhost
with the correct ports (e.g., 5000
).
Once the backend API is running, start the React development server:
npm start
Access the project at http://localhost:3000.
Organized for scalability and ease of development:
src/
├── components/ // Reusable React components
│ ├── chatbox.js // Handles chatbot UI and message rendering
│ ├── doc-upload.js // Handles displaying PDFs like whitepapers
└── App.js // Main application entry point
Library | Purpose |
---|---|
React | Core framework for building the application |
Ant Design | Prebuilt UI components and styling |
PDF.js | Viewing crypto whitepapers or PDFs |
WebSocket | Real-time communication with the crypto backend |
This chatbot can be customized for various crypto-related use cases:
- Get live cryptocurrency price updates (e.g., Bitcoin, Ethereum).
- Access FAQs about crypto trading, wallets, or technology.
- Display cryptocurrency whitepapers or PDF documents for users.
- Offer educational content about blockchain and crypto in an interactive conversation.
Contributions are welcome! Feel free to fork this repository, make updates, and submit a pull request.
If you encounter any issues or have feature requests, file an issue in this repository.
Special thanks to:
- Ant Design Team for providing highly customizable UI components.
- Mozilla's PDF.js for the PDF viewer.
- The open-source community for making amazing libraries and frameworks available.
- The cryptocurrency community for inspiring use cases and projects.
Potential ideas to extend the project's functionality:
- Multi-Language Support: Add NLP support for multiple languages.
- Authentication: Secure the chatbot with user logins for personalized responses.
- Crypto Market Analytics: Show advanced charts or real-time metrics for crypto prices.
- Bot Training: Integrate machine learning models for intelligent crypto-related query handling.