mirror of
https://github.com/memohai/Memoh.git
synced 2026-04-27 07:16:19 +09:00
bc374fe8cd
* refactor(attachment): multimodal attachment refactor with snapshot schema and storage layer - Add snapshot schema migration (0008) and update init/versions/snapshots - Add internal/attachment and internal/channel normalize for unified attachment handling - Move containerfs provider from internal/media to internal/storage - Update agent types, channel adapters (Telegram/Feishu), inbound and handlers - Add containerd snapshot lineage and local_channel tests - Regenerate sqlc, swagger and SDK * refactor(media): content-addressed asset system with unified naming - Replace asset_id foreign key with content_hash as sole identifier for bot_history_message_assets (pure soft-link model) - Remove mime, size_bytes, storage_key from DB; derive at read time via media.Resolve from actual storage - Merge migrations 0008/0009 into single 0008; keep 0001 as canonical schema - Add Docker initdb script for deterministic migration execution order - Fix cross-channel real-time image display (Telegram → WebUI SSE) - Fix message disappearing on refresh (null assets fallback) - Fix file icon instead of image preview (mime derivation from storage) - Unify AssetID → ContentHash naming across Go, Agent, and Frontend - Change storage key prefix from 4-char to 2-char for directory sharding - Add server-entrypoint.sh for Docker deployment migration handling * refactor(infra): embedded migrations, Docker simplification, and config consolidation - Embed SQL migrations into Go binary, removing shell-based migration scripts - Consolidate config files into conf/ directory (app.example.toml, app.docker.toml, app.dev.toml) - Simplify Docker setup: remove initdb.d scripts, streamline nginx config and entrypoint - Remove legacy CLI, feishu-echo commands, and obsolete incremental migration files - Update install script and docs to require sudo for one-click install - Add mise tasks for dev environment orchestration * chore: recover migrations --------- Co-authored-by: Acbox <acbox0328@gmail.com>
78 lines
2.3 KiB
Markdown
78 lines
2.3 KiB
Markdown
# Contributing Guide
|
|
|
|
## Prerequisites
|
|
|
|
- [Docker](https://docs.docker.com/get-docker/) (for dev infrastructure)
|
|
- [mise](https://mise.jdx.dev/) (task runner & toolchain manager)
|
|
|
|
### Install mise
|
|
|
|
```bash
|
|
# macOS / Linux
|
|
curl https://mise.run | sh
|
|
# or
|
|
brew install mise
|
|
|
|
# Windows
|
|
winget install jdx.mise
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
mise install # Install toolchains (Go, Node, Bun, pnpm, sqlc)
|
|
mise run setup # Start infra + copy config + migrate DB + install deps
|
|
mise run dev # Start server + agent + web (all hot-reload)
|
|
```
|
|
|
|
That's it. `setup` handles everything automatically:
|
|
1. Copies `conf/app.dev.toml` → `config.toml` (if not exists)
|
|
2. Starts PostgreSQL + Qdrant via `devenv/docker-compose.yml`
|
|
3. Runs database migrations
|
|
4. Installs Go/Node/pnpm dependencies
|
|
|
|
## Daily Development
|
|
|
|
```bash
|
|
mise run dev # Start all services with hot-reload
|
|
```
|
|
|
|
## Infrastructure
|
|
|
|
```bash
|
|
mise run infra # Start dev postgres + qdrant
|
|
mise run infra-down # Stop dev infrastructure
|
|
mise run infra-logs # View infrastructure logs
|
|
```
|
|
|
|
## More Commands
|
|
|
|
| Command | Description |
|
|
| ------- | ----------- |
|
|
| `mise run dev` | Start development environment |
|
|
| `mise run setup` | Full setup (infra + config + migrate + deps) |
|
|
| `mise run infra` | Start dev infrastructure only |
|
|
| `mise run infra-down` | Stop dev infrastructure |
|
|
| `mise run db-up` | Run database migrations |
|
|
| `mise run db-down` | Roll back database migrations |
|
|
| `mise run swagger-generate` | Generate Swagger documentation |
|
|
| `mise run sdk-generate` | Generate TypeScript SDK |
|
|
| `mise run sqlc-generate` | Generate SQL code |
|
|
| `mise run //agent:dev` | Start agent gateway only |
|
|
| `mise run //cmd/agent:start` | Start main server only |
|
|
| `mise run //packages/web:dev` | Start web dev server only |
|
|
|
|
## Project Layout
|
|
|
|
```
|
|
conf/ — Configuration templates (app.example.toml, app.dev.toml, app.docker.toml)
|
|
devenv/ — Development infrastructure (docker-compose for postgres + qdrant)
|
|
docker/ — Production Docker build & runtime (Dockerfiles, entrypoints)
|
|
cmd/ — Go application entry points
|
|
internal/ — Go backend core code
|
|
agent/ — Agent Gateway (Bun/Elysia)
|
|
packages/ — Frontend monorepo (web, ui, sdk, cli, config)
|
|
db/ — Database migrations and queries
|
|
scripts/ — Utility scripts
|
|
```
|