chore: update README

This commit is contained in:
medcl
2024-10-13 17:55:35 +08:00
parent 88e9aeb11b
commit 0998da1cd9

View File

@@ -1,23 +1,54 @@
# Tauri + React + Typescript
# INFINI Coco - Connect & Collaborate
**Tagline**: _"Search, connect, collaborate all in one place."_
To get started run:
cd coco
pnpm install
pnpm tauri android init
pnpm tauri ios init
Coco 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.
For Desktop development, run:
pnpm tauri dev
> **Note**: Backend services, including data indexing and search functionality, are handled in a separate repository.
## Vision
At Coco, 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
- **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 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.
## Getting Started
### Initial Setup
To set up the Coco App for development:
```bash
cd coco
pnpm install
pnpm tauri android init
pnpm tauri ios init
```
#### Desktop Development:
To start desktop development, run:
```
pnpm tauri dev
```
#### Android Development:
For Android development, run:
pnpm tauri android dev
```
pnpm tauri android dev
```
#### iOS Development:
For iOS development, run:
pnpm tauri ios dev
## Recommended IDE Setup
- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
```
pnpm tauri ios dev
```