mirror of
https://github.com/infinilabs/coco-app.git
synced 2025-12-16 11:37:47 +01:00
docs: update README (#418)
This commit is contained in:
85
README.md
85
README.md
@@ -1,7 +1,15 @@
|
||||
# Coco AI - Connect & Collaborate
|
||||
|
||||
<div align="center">
|
||||
|
||||
**Tagline**: _"Coco AI - search, connect, collaborate – all in one place."_
|
||||
|
||||
Visit our website: [https://coco.rs](https://coco.rs)
|
||||
|
||||
[](LICENSE) [](https://tauri.app/) [](https://react.dev/) [](https://www.typescriptlang.org/) [](https://www.rust-lang.org/) [](https://nodejs.org/) [](https://github.com/infinilabs/coco-app/pulls) [](https://github.com/infinilabs/coco-app/releases) [](https://github.com/infinilabs/coco-app/actions) [](https://discord.com/invite/4tKTMkkvVX)
|
||||
|
||||
</div>
|
||||
|
||||
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
|
||||
@@ -12,20 +20,15 @@ and internal resources. Coco enhances collaboration by making information instan
|
||||
insights based on your enterprise's specific data.
|
||||
|
||||
> **Note**: Backend services, including data indexing and search functionality, are handled in a
|
||||
> separate [repository](https://github.com/infinilabs/coco-server).
|
||||
separate [repository](https://github.com/infinilabs/coco-server).
|
||||
|
||||

|
||||
|
||||

|
||||
## 🚀 Vision
|
||||
|
||||
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.
|
||||
|
||||
## Vision
|
||||
|
||||
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.
|
||||
|
||||
## Use Cases
|
||||
## 💡 Use Cases
|
||||
|
||||
- **Unified Search Across Platforms**: Coco integrates with all your enterprise apps, letting you search documents,
|
||||
conversations, and files across Google Workspace, Dropbox, GitHub, etc.
|
||||
@@ -36,37 +39,67 @@ workspace.
|
||||
- **Simplified Data Access**: By removing the friction between various tools, Coco enhances your workflow and increases
|
||||
productivity.
|
||||
|
||||
## Getting Started
|
||||
## ✨ Key Features
|
||||
|
||||
### Initial Setup
|
||||
- 🔍 **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
|
||||
|
||||
**This version of pnpm requires at least Node.js v18.12**
|
||||
## 🛠️ Technology Stack
|
||||
|
||||
To set up the Coco App for development:
|
||||
- **Frontend**: React + TypeScript
|
||||
- **Desktop Framework**: Tauri 2.0
|
||||
- **Styling**: Tailwind CSS
|
||||
- **State Management**: Zustand
|
||||
- **Build Tool**: Vite
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js >= 18.12
|
||||
- Rust (latest stable)
|
||||
- pnpm (package manager)
|
||||
|
||||
### Development Setup
|
||||
|
||||
```bash
|
||||
cd coco-app
|
||||
# Install pnpm
|
||||
npm install -g pnpm
|
||||
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
# Start development server
|
||||
pnpm tauri dev
|
||||
```
|
||||
|
||||
#### Desktop Development:
|
||||
|
||||
To start desktop development, run:
|
||||
### Production Build
|
||||
|
||||
```bash
|
||||
pnpm tauri dev
|
||||
pnpm tauri build
|
||||
```
|
||||
|
||||
## Documentation
|
||||
## 📚 Documentation
|
||||
|
||||
For full documentation on Coco AI, please visit the [Coco AI Documentation](https://docs.infinilabs.com/coco-app/main/).
|
||||
- [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/)
|
||||
|
||||
## License
|
||||
## 📄 License
|
||||
|
||||
Coco AI is an open-source project licensed under
|
||||
the [MIT License](https://github.com/infinilabs/coco-app/blob/main/LICENSE).
|
||||
|
||||
This means that you can freely use, modify, and
|
||||
Coco AI is an open-source project licensed under the [MIT License](LICENSE). You can freely use, modify, and
|
||||
distribute the software for both personal and commercial purposes, including hosting it on your own servers.
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
Built with ❤️ by <a href="https://infinilabs.com">INFINI Labs</a>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user