Skip to content

Crypto Chatbot UI is a React-based user interface designed to interact with a backend cryptocurrency chatbot. It enables users to ask crypto-related queries, access FAQs, view live market updates, and browse whitepapers or documents in PDF format.

Notifications You must be signed in to change notification settings

softdev629/crypto-ai-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Crypto Chatbot UI

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.


Features

  • 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.

Prerequisites

  1. Node.js (v16 or later): Install Node.js from nodejs.org.
  2. Chatbot Backend API: The chatbot interacts with a backend API. Ensure the backend service handling the crypto-related chatbot data is up and running.

Getting Started

Follow these steps to set up and test the Crypto Chatbot UI locally:

1. Clone the Repository

git clone https://github.com/softdev629/crypto-ai-client.git
cd crypto-ai-client

2. Install Dependencies

npm install

3. Run the Backend API

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).


4. Start the Development Server

Once the backend API is running, start the React development server:

npm start

Access the project at http://localhost:3000.


Folder Structure

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

Libraries Used

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

Use Cases

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.

Contributing

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.


Acknowledgments

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.

Future Enhancements

Potential ideas to extend the project's functionality:

  1. Multi-Language Support: Add NLP support for multiple languages.
  2. Authentication: Secure the chatbot with user logins for personalized responses.
  3. Crypto Market Analytics: Show advanced charts or real-time metrics for crypto prices.
  4. Bot Training: Integrate machine learning models for intelligent crypto-related query handling.

About

Crypto Chatbot UI is a React-based user interface designed to interact with a backend cryptocurrency chatbot. It enables users to ask crypto-related queries, access FAQs, view live market updates, and browse whitepapers or documents in PDF format.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published