Files
coco-app/README.md

112 lines
4.8 KiB
Markdown
Raw Normal View History

2024-10-23 16:39:32 +08:00
# Coco AI - Connect & Collaborate
2024-10-13 17:41:16 +08:00
2025-04-23 14:49:23 +08:00
<div align="center">
2024-10-23 16:39:32 +08:00
**Tagline**: _"Coco AI - search, connect, collaborate all in one place."_
2024-10-13 17:41:16 +08:00
2025-04-23 14:49:23 +08:00
Visit our website: [https://coco.rs](https://coco.rs)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![Tauri 2.0](https://img.shields.io/badge/Tauri-2.0-blue)](https://tauri.app/) [![React](https://img.shields.io/badge/React-18-blue)](https://react.dev/) [![TypeScript](https://img.shields.io/badge/TypeScript-5-blue)](https://www.typescriptlang.org/) [![Rust](https://img.shields.io/badge/Rust-latest-orange)](https://www.rust-lang.org/) [![Node](https://img.shields.io/badge/Node-%3E%3D18.12-green)](https://nodejs.org/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/infinilabs/coco-app/pulls) [![Version](https://img.shields.io/github/v/release/infinilabs/coco-app)](https://github.com/infinilabs/coco-app/releases) [![Build Status](https://img.shields.io/github/actions/workflow/status/infinilabs/coco-app/ci.yml)](https://github.com/infinilabs/coco-app/actions) [![Discord](https://img.shields.io/discord/1122384609359966313)](https://discord.com/invite/4tKTMkkvVX)
</div>
2025-02-23 19:09:31 +08:00
Coco AI is a unified search platform that connects all your enterprise applications and data—Google Workspace, Dropbox,
Confluent Wiki, GitHub, and more—into a single, powerful search interface. This repository contains the **Coco App**,
built for both **desktop and mobile**. The app allows users to search and interact with their enterprise data across
platforms.
2024-10-13 17:41:16 +08:00
2025-02-23 19:09:31 +08:00
In addition, Coco offers a **Gen-AI Chat for Teams**—imagine **ChatGPT** but tailored to your teams unique knowledge
and internal resources. Coco enhances collaboration by making information instantly accessible and providing AI-driven
insights based on your enterprise's specific data.
2024-10-23 16:39:32 +08:00
2025-02-23 19:09:31 +08:00
> **Note**: Backend services, including data indexing and search functionality, are handled in a
2025-04-23 14:49:23 +08:00
separate [repository](https://github.com/infinilabs/coco-server).
2025-04-03 09:42:09 +08:00
2025-04-23 14:49:23 +08:00
![Coco AI](./docs/static/img/coco-preview.gif)
2025-04-03 09:42:09 +08:00
2025-04-23 14:49:23 +08:00
## 🚀 Vision
2025-04-03 09:42:09 +08:00
2025-04-23 14:49:23 +08:00
At Coco AI, we aim to streamline workplace collaboration by centralizing access to enterprise data. The Coco App provides a seamless, cross-platform experience, enabling teams to easily search, connect, and collaborate within their workspace.
2024-10-13 17:41:16 +08:00
2025-04-23 14:49:23 +08:00
## 💡 Use Cases
2024-10-13 17:55:35 +08:00
2025-02-23 19:09:31 +08:00
- **Unified Search Across Platforms**: Coco integrates with all your enterprise apps, letting you search documents,
conversations, and files across Google Workspace, Dropbox, GitHub, etc.
- **Cross-Platform Access**: The app is available for both desktop and mobile, so you can access your workspace from
anywhere.
- **Seamless Collaboration**: Coco's search and Gen-AI chat capabilities help teams quickly find and share information,
improving workplace efficiency.
- **Simplified Data Access**: By removing the friction between various tools, Coco enhances your workflow and increases
productivity.
2024-10-13 17:55:35 +08:00
2025-04-23 14:49:23 +08:00
## ✨ Key Features
- 🔍 **Unified Search**: One-stop enterprise search with multi-platform integration
- Supports major collaboration platforms: Google Workspace, Dropbox, Confluence Wiki, GitHub, etc.
- Real-time search across documents, conversations, and files
- Smart search intent understanding with relevance ranking
- Cross-platform data correlation and context display
- 🤖 **AI-Powered Chat**: Team-specific ChatGPT-like assistant trained on your enterprise data
- 🌐 **Cross-Platform**: Available for Windows, macOS, Linux and Web
- 🔒 **Security-First**: Support for private deployment and data sovereignty
-**High Performance**: Built with Rust and Tauri 2.0
- 🎨 **Modern UI**: Sleek interface designed for productivity
## 🛠️ Technology Stack
- **Frontend**: React + TypeScript
- **Desktop Framework**: Tauri 2.0
- **Styling**: Tailwind CSS
- **State Management**: Zustand
- **Build Tool**: Vite
2024-10-13 17:55:35 +08:00
2025-04-23 14:49:23 +08:00
## 🚀 Getting Started
2024-10-13 17:55:35 +08:00
2025-04-23 14:49:23 +08:00
### Prerequisites
2025-04-23 14:49:23 +08:00
- Node.js >= 18.12
- Rust (latest stable)
- pnpm (package manager)
### Development Setup
2024-10-13 17:41:16 +08:00
2024-10-13 17:55:35 +08:00
```bash
2025-04-23 14:49:23 +08:00
# Install pnpm
2024-11-07 16:32:49 +08:00
npm install -g pnpm
2025-04-23 14:49:23 +08:00
# Install dependencies
2024-10-13 17:55:35 +08:00
pnpm install
2025-04-23 14:49:23 +08:00
# Start development server
pnpm tauri dev
2024-10-13 17:55:35 +08:00
```
2024-10-13 17:41:16 +08:00
2025-04-23 14:49:23 +08:00
### Production Build
2024-10-13 17:41:16 +08:00
2025-02-23 19:09:31 +08:00
```bash
2025-04-23 14:49:23 +08:00
pnpm tauri build
2024-10-13 17:55:35 +08:00
```
2025-02-23 19:09:31 +08:00
2025-04-23 14:49:23 +08:00
## 📚 Documentation
2025-02-23 19:09:31 +08:00
2025-04-23 14:49:23 +08:00
- [Coco App Documentation](https://docs.infinilabs.com/coco-app/main/)
- [Coco Server Documentation](https://docs.infinilabs.com/coco-server/main/)
- [Tauri Documentation](https://tauri.app/)
2025-02-23 19:09:31 +08:00
2025-05-13 18:13:39 +08:00
## Contributors
<a href="https://github.com/infinilabs/coco-app/graphs/contributors">
<img src="https://contrib.rocks/image?repo=infinilabs/coco-app" />
</a>
2025-04-23 14:49:23 +08:00
## 📄 License
2025-02-23 19:09:31 +08:00
2025-04-23 14:49:23 +08:00
Coco AI is an open-source project licensed under the [MIT License](LICENSE). You can freely use, modify, and
2025-04-03 09:42:09 +08:00
distribute the software for both personal and commercial purposes, including hosting it on your own servers.
2025-04-23 14:49:23 +08:00
---
<div align="center">
Built with ❤️ by <a href="https://infinilabs.com">INFINI Labs</a>
</div>