{"id":23978148,"url":"https://github.com/softdev629/crypto-ai-client","last_synced_at":"2025-02-24T18:52:46.712Z","repository":{"id":156707354,"uuid":"630347650","full_name":"softdev629/crypto-ai-client","owner":"softdev629","description":"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. ","archived":false,"fork":false,"pushed_at":"2024-12-20T02:33:50.000Z","size":1893,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-07T08:17:00.666Z","etag":null,"topics":["antd","chatbot","react","react-use-websocket"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/softdev629.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-04-20T07:32:26.000Z","updated_at":"2024-12-20T02:35:24.000Z","dependencies_parsed_at":"2023-07-20T03:16:05.298Z","dependency_job_id":null,"html_url":"https://github.com/softdev629/crypto-ai-client","commit_stats":null,"previous_names":["maksymdev701/crypto-ai-client","softdev629/crypto-ai-client"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softdev629%2Fcrypto-ai-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softdev629%2Fcrypto-ai-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softdev629%2Fcrypto-ai-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softdev629%2Fcrypto-ai-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/softdev629","download_url":"https://codeload.github.com/softdev629/crypto-ai-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240540554,"owners_count":19817791,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antd","chatbot","react","react-use-websocket"],"created_at":"2025-01-07T08:17:03.240Z","updated_at":"2025-02-24T18:52:46.684Z","avatar_url":"https://github.com/softdev629.png","language":"JavaScript","readme":"# Crypto Chatbot UI\n\nA **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**.\n\n---\n\n## Features\n\n- **Crypto-Focused Chatbot Interface**: Engage with a chatbot specifically customized for cryptocurrency tasks like price tracking, updates, FAQs, or educational material.\n- **PDF Viewer**: Easily view cryptocurrency whitepapers, reports, or guides using [PDF.js library](https://mozilla.github.io/pdf.js/).\n- **Ant Design UI**: Elegant and intuitive user interface with Ant Design components.\n- **Real-Time Communication**: Real-time message exchange powered by WebSocket hooks.\n\n---\n\n## Prerequisites\n\n1. **Node.js** (v16 or later): Install Node.js from [nodejs.org](https://nodejs.org/).\n2. **Chatbot Backend API**: The chatbot interacts with a backend API. Ensure the backend service handling the crypto-related chatbot data is up and running.\n\n---\n\n## Getting Started\n\nFollow these steps to set up and test the Crypto Chatbot UI locally:\n\n### 1. Clone the Repository\n\n```bash\ngit clone https://github.com/softdev629/crypto-ai-client.git\ncd crypto-ai-client\n```\n\n### 2. Install Dependencies\n\n```bash\nnpm install\n```\n\n### 3. Run the Backend API\n\nEnsure the chatbot API backend (which provides cryptocurrency-related answers and functionality) is properly configured and running. Follow the backend repository setup instructions for details.\n\nIf you're testing locally, ensure your backend listens on `localhost` with the correct ports (e.g., `5000`).\n\n---\n\n### 4. Start the Development Server\n\nOnce the backend API is running, start the React development server:\n\n```bash\nnpm start\n```\n\nAccess the project at [http://localhost:3000](http://localhost:3000).\n\n---\n\n## Folder Structure\n\nOrganized for scalability and ease of development:\n\n```\nsrc/\n├── components/          // Reusable React components\n│   ├── chatbox.js         // Handles chatbot UI and message rendering\n│   ├── doc-upload.js       // Handles displaying PDFs like whitepapers\n└── App.js               // Main application entry point\n```\n\n---\n\n## Libraries Used\n\n| Library                            | Purpose                                      |\n|------------------------------------|----------------------------------------------|\n| [React](https://reactjs.org)       | Core framework for building the application  |\n| [Ant Design](https://ant.design/)  | Prebuilt UI components and styling           |\n| [PDF.js](https://mozilla.github.io/pdf.js/) | Viewing crypto whitepapers or PDFs        |\n| [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) | Real-time communication with the crypto backend  |\n\n---\n\n## Use Cases\n\nThis chatbot can be customized for various crypto-related use cases:\n\n- Get live cryptocurrency price updates (e.g., Bitcoin, Ethereum).\n- Access FAQs about crypto trading, wallets, or technology.\n- Display cryptocurrency whitepapers or PDF documents for users.\n- Offer educational content about blockchain and crypto in an interactive conversation.\n\n---\n\n## Contributing\n\nContributions are welcome! Feel free to fork this repository, make updates, and submit a pull request.\n\nIf you encounter any issues or have feature requests, file an issue in this repository.\n\n---\n\n## Acknowledgments\n\nSpecial thanks to:\n\n- **Ant Design Team** for providing highly customizable UI components.\n- **Mozilla's PDF.js** for the PDF viewer.\n- The open-source community for making amazing libraries and frameworks available.\n- The cryptocurrency community for inspiring use cases and projects.\n\n---\n\n## Future Enhancements\n\nPotential ideas to extend the project's functionality:\n\n1. **Multi-Language Support**: Add NLP support for multiple languages.\n2. **Authentication**: Secure the chatbot with user logins for personalized responses.\n3. **Crypto Market Analytics**: Show advanced charts or real-time metrics for crypto prices.\n4. **Bot Training**: Integrate machine learning models for intelligent crypto-related query handling.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftdev629%2Fcrypto-ai-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftdev629%2Fcrypto-ai-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftdev629%2Fcrypto-ai-client/lists"}