Skip to content

Commit c9f5f87

Browse files
authored
docs: clarify that frontend source is not in this public repo (#11)
2 parents 5a50b8b + 89d62d8 commit c9f5f87

3 files changed

Lines changed: 2 additions & 24 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
Sico is an open-source AI agent platform with three main services that communicate via gRPC and a bidirectional "reverse RPC" pattern. The backend handles HTTP APIs and persistence, the core handles AI/LLM orchestration, and the frontend provides a React dashboard.
7+
Sico is an open-source AI agent platform with three main services that communicate via gRPC and a bidirectional "reverse RPC" pattern. The backend handles HTTP APIs and persistence, the core handles AI/LLM orchestration, and the frontend provides a React dashboard (frontend codebase is not opensourced).
88

99
## Build & Run Commands
1010

@@ -41,19 +41,6 @@ uv run ruff format . # format
4141
```
4242
Requires Python >=3.13. Uses `uv` for dependency management (pyproject.toml + uv.lock).
4343

44-
### Frontend (React + pnpm)
45-
```bash
46-
cd frontend
47-
pnpm install # install dependencies
48-
pnpm dev # start dev server (vite)
49-
pnpm build # production build (tsc -b && vite build)
50-
pnpm lint # eslint
51-
pnpm lint:fix
52-
pnpm format # prettier
53-
pnpm format:check
54-
```
55-
Single-package React app (package name `sico-frontend`, private). Uses Vite + Tailwind + styled-components + React Router. TypeScript path alias `@``frontend/src/`.
56-
5744
### Protobuf Code Generation
5845
All `.proto` files live in `proto/`. Generation scripts are run from the `proto/` directory:
5946
```bash
@@ -121,14 +108,6 @@ Key patterns:
121108
- **`app/pb/`** — Auto-generated protobuf/betterproto2 stubs (do not edit manually).
122109
- **`app/utils/`** — Shared utilities: Redis, caching, eventbus, response builders.
123110

124-
### Frontend Structure (TypeScript/React — `frontend/`)
125-
126-
- Single-package React app rooted at `frontend/` (not a monorepo). Package name `sico-frontend`, private, managed with pnpm.
127-
- **`src/`** — app source: `pages/`, `components/`, `api/`, `hooks/`, `utils/`, `assets/`; `App.tsx` + `main.tsx` + `PlatformRouter.tsx` entry.
128-
- **`public/`** — static assets (includes `pdfjs/` worker).
129-
- **`proto-types/src/`** — generated TS types from protobuf (do not edit manually; emitted by `bash gen.sh` in `proto/`).
130-
- Uses Vite, Tailwind CSS, styled-components, React Router, and `@` path alias mapped to `src/`.
131-
132111
### Sandbox System
133112

134113
The sandbox subsystem manages isolated environments (Android emulators, AIO containers) for agent tool execution. Sandboxes are pooled and leased to agent instances. The `sandbox/emulator/` directory contains the Android emulator sandbox implementation (Python).

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,6 @@ make kind-down # tear down and delete local cluster data
196196
sico/
197197
├── backend/ # Go HTTP + gRPC service (Gin, GORM, Wire)
198198
├── core/ # Python agent orchestration service (asyncio, grpclib)
199-
├── frontend/ # Packaged/deployment frontend assets (source package is separate)
200199
├── proto/ # Protobuf definitions shared by all services
201200
├── sandbox/ # Sandbox runtimes (Android emulator, ...)
202201
├── skills/ # Packaged Digital Worker skills

docs/technical_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Sico separates AI orchestration from data persistence with a protobuf-driven gRP
129129
|---------|----------|-----------|---------------|
130130
| **Backend** | Go | Gin | HTTP API gateway, JWT/Casbin auth for operator-facing APIs, sandbox-client HMAC auth, data persistence, reverse gRPC server |
131131
| **Core** | Python | asyncio | Agent orchestration, LLM invocation, tool execution, Experience Learning; no direct MySQL access, with runtime state in workspace files and memory/vector stores |
132-
| **Frontend** | - | - | Operator-facing web client for human users (not open source) |
132+
| **Frontend** | TypeScript | React / Vite | Operator-facing web client for human users; source code is not currently published in this repository and is distributed separately as a packaged archive |
133133

134134
Sico uses two services because AI orchestration and platform responsibilities evolve at different speeds and benefit from different runtimes. The Backend service is implemented in Go for high-throughput HTTP handling. The Core service is implemented in Python to support rapid iteration across the AI/LLM ecosystem. This separation decouples deployment cycles and allows each service to optimize for its primary workload.
135135

0 commit comments

Comments
 (0)