{"id":24313894,"url":"https://github.com/litongjava/antx-chat-ui","last_synced_at":"2025-08-20T11:08:22.339Z","repository":{"id":272422746,"uuid":"916536495","full_name":"litongjava/antx-chat-ui","owner":"litongjava","description":"antx-chat-ui","archived":false,"fork":false,"pushed_at":"2025-08-05T06:59:50.000Z","size":609,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-05T08:45:37.075Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://antx-chat-ui.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/litongjava.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-01-14T09:40:35.000Z","updated_at":"2025-08-05T06:59:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"a9cb1109-7189-4e32-8f5d-4b1cb5a22fff","html_url":"https://github.com/litongjava/antx-chat-ui","commit_stats":null,"previous_names":["litongjava/antx-chat-ui"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/litongjava/antx-chat-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litongjava%2Fantx-chat-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litongjava%2Fantx-chat-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litongjava%2Fantx-chat-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litongjava%2Fantx-chat-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/litongjava","download_url":"https://codeload.github.com/litongjava/antx-chat-ui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/litongjava%2Fantx-chat-ui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271306829,"owners_count":24736770,"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","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-01-17T09:14:29.992Z","updated_at":"2025-08-20T11:08:22.333Z","avatar_url":"https://github.com/litongjava.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AntX Chat UI\n\n## Introduction\n\nAntX Chat UI is a front-end chat interface built with **React**, **TypeScript**, **Vite**, and **Ant Design X**. It offers a sleek and intuitive user experience designed for AI-driven applications, with a particular focus on AGI (Artificial General Intelligence) solutions.\n\nKey highlights include:\n\n- **OpenAI Protocol for Communication**: The front end communicates with the back end using OpenAI’s protocol.\n- **No Local Chat Logs**: All chat logs are stored on the back end. The front end does not store or cache any conversation data.\n\n## Features\n\n- **React** and **TypeScript** for a robust, maintainable codebase.\n- **Vite** for lightning-fast development.\n- **Ant Design X** integration for a modern, elegant interface.\n- **Markdown** support for rich text rendering.\n- Organized tabs for categorized conversations (e.g., *Hot Topics*, *Design Guide*).\n- Smooth user interactions and enhanced UI responsiveness.\n\n## Demo\n[Demo](https://antx-chat-ui.vercel.app/)\n\n![main.png](readme_files/main.png)\n\n## Getting Started\n\nFollow the steps below to set up and run AntX Chat UI on your local machine.\n\n### Prerequisites\n\nMake sure you have the following installed:\n\n- Node.js (v16 or higher)\n- npm or yarn\n\n### Installation\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/litongjava/antx-chat-ui.git\n   cd antx-chat-ui\n   ```\n\n2. **Install the dependencies:**\n\n   ```bash\n   npm install\n   ```\n   Or\n   ```bash\n   yarn install\n   ```\n\n### Running the Project\n\nTo start the development server, run:\n\n```bash\nnpm run dev\n```\n\nOr\n\n```bash\nyarn dev\n```\n\nThe application will be accessible at [http://localhost:3000/](http://localhost:3000/).\n\n### Building for Production\n\nTo build the project for production, use:\n\n```bash\nnpm run build\n```\n\nOr\n\n```bash\nyarn build\n```\n\nThe output files will be placed in the `dist` folder.\n\n### Deploying\n\nYou can deploy the built project to any static hosting service such as Netlify, Vercel, or GitHub Pages.\n\n## Project Structure\n\n```\nantx-chat-ui/\n├── public/          # Static assets\n├── src/\n│   ├── components/  # Reusable components\n│   ├── pages/       # Application pages\n│   ├── styles/      # CSS/SCSS files\n│   └── main.tsx     # Entry point\n├── vite.config.ts   # Vite configuration\n├── package.json     # Project metadata\n└── README.md        # Project documentation\n```\n\n## Markdown Support\n\nThe chat interface supports Markdown syntax for rich text formatting. Users can write messages with Markdown, which will be rendered in the chat window.\n\n### Supported Markdown Elements\n\n- **Headings**\n- **Bold and Italic Text**\n- **Lists** (ordered and unordered)\n- **Links**\n- **Images**\n- **Code Blocks**\n\n## Communication Protocol\n\nThis project uses the **OpenAI** protocol to handle interactions between the front end and the back end. All chat requests and responses flow through this protocol, ensuring a consistent and secure data exchange for AI-driven features.\n\n## Data Storage\n\nTo maintain user privacy and ensure optimal data consistency:\n\n- **Front End**: Does **not** store any chat logs locally.\n- **Back End**: Manages and stores all conversation history.\n\nThis approach ensures that user data remains safe and that any data manipulations or retrievals happen strictly on the server side.\n\n## Customization\n\nYou can tailor the UI and functionality by updating the following:\n\n- **src/components/**: Reusable UI components.\n- **src/pages/**: Page-level components and layouts.\n- **src/styles/**: Global styles, theming, and CSS/SCSS files.\n\n## Contributing\n\nContributions are welcome! Feel free to open a pull request or file an issue to improve this project.\n\n### Steps to Contribute\n\n1. **Fork the repository**.\n2. **Create a new branch**:\n   ```bash\n   git checkout -b feature/your-feature-name\n   ```\n3. **Make your changes and commit**:\n   ```bash\n   git commit -m \"Add a meaningful commit message\"\n   ```\n4. **Push to your branch**:\n   ```bash\n   git push origin feature/your-feature-name\n   ```\n5. **Open a pull request**.\n\n## License\n\nThis project is licensed under the **MIT License**. Refer to the [LICENSE](./LICENSE) file for more details.\n\n## Acknowledgments\n\n- **Ant Design X**: A fantastic UI framework that elevates the project's design and user experience.\n- The open-source community for providing valuable tools and support.\n\n## Contact\n\nFor inquiries or feedback, please reach out via:\n\n- **Email**: [litongjava001@gmail.com](mailto:litongjava001@gmail.com)\n- **GitHub**: [Litong Java](https://github.com/litongjava)\n\n---  \n\nFeel free to adapt the content and structure as needed. Happy coding!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flitongjava%2Fantx-chat-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flitongjava%2Fantx-chat-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flitongjava%2Fantx-chat-ui/lists"}