release: v0.1.0 - Production Release
Release Date: 2026-10-11 New Documents: - CHANGELOG.md - Complete version history - RELEASE_v0.1.0_INSTALLATION_GUIDE.md - Installation guide for admin team - README.md - Project overview and quick start - build_release.sh - Automated build script Features: - ✅ Search pagination with "Load More" button - ✅ Library displays 118 files correctly - ✅ Scene VLM status visualization - ✅ Advanced Mode toggle - ✅ Complete architecture documentation Release Package: - tar.gz archive with all necessary files - Startup/stop scripts - Installation guide - Checksum verification For Admin Team: - See RELEASE_v0.1.0_INSTALLATION_GUIDE.md - Run ./build_release.sh to create package - Package includes: frontend, proxy, docs, scripts
This commit is contained in:
240
README.md
Normal file
240
README.md
Normal file
@@ -0,0 +1,240 @@
|
||||
# Momentry Studio
|
||||
|
||||
**Version**: 0.1.0
|
||||
**Status**: Production Release
|
||||
**Release Date**: 2026-10-11
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Momentry Studio is a **video analysis platform** with intelligent search capabilities, built with Vue 3, TypeScript, and Tauri 2.
|
||||
|
||||
### Key Features
|
||||
|
||||
- **🔍 Multi-Mode Search**: Keyword, Semantic, Visual, Agent, People
|
||||
- **📄 Progressive Loading**: Top 5 results initially, load more on demand
|
||||
- **📚 Library Management**: 118+ files with status tracking
|
||||
- **🎭 Face Recognition**: Identity management and clustering
|
||||
- **📊 Pipeline Visualization**: 10-stage processing progress
|
||||
- **🎨 Advanced Mode**: QC tools and detailed controls
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js 18+
|
||||
- Rust 1.70+
|
||||
- PostgreSQL 14+
|
||||
- Qdrant 1.6+
|
||||
- Momentry Core API (port 3002)
|
||||
- MarkBase API (port 11438)
|
||||
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://github.com/anomalyco/momentry_studio.git
|
||||
cd momentry_studio
|
||||
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Build frontend
|
||||
npm run build
|
||||
|
||||
# Start proxy (requires Core API running)
|
||||
npm run proxy
|
||||
|
||||
# Access: http://localhost:8888
|
||||
```
|
||||
|
||||
### Development
|
||||
|
||||
```bash
|
||||
# Start dev server (proxy + vite)
|
||||
npm run dev
|
||||
|
||||
# Access: http://localhost:5173
|
||||
```
|
||||
|
||||
### Desktop App
|
||||
|
||||
```bash
|
||||
# Build native macOS app
|
||||
cargo tauri build
|
||||
|
||||
# Output: src-tauri/target/release/bundle/dmg/momentry-studio_0.1.0_arm64.dmg
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
### 4 Core Modules
|
||||
|
||||
1. **Search Module** - Multi-mode search with history and bookmarks
|
||||
2. **File Prep/Processing** - Pipeline management and status tracking
|
||||
3. **Admin Module** - System monitoring and configuration
|
||||
4. **File Management** - Upload, download, and file organization
|
||||
|
||||
### Tech Stack
|
||||
|
||||
| Layer | Technology |
|
||||
|-------|-----------|
|
||||
| **Frontend** | Vue 3 + TypeScript + Vite |
|
||||
| **Desktop** | Tauri 2 (Rust) |
|
||||
| **API Gateway** | Axum (Rust) on port 8888 |
|
||||
| **Core API** | Rust on port 3002 |
|
||||
| **MarkBase API** | Go on port 11438 |
|
||||
| **Database** | PostgreSQL + Qdrant + SQLite |
|
||||
| **Cache** | Redis (optional) |
|
||||
|
||||
---
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### Momentry Core API (v1)
|
||||
|
||||
- `/api/v1/search/*` - Search operations
|
||||
- `/api/v1/files/*` - File management
|
||||
- `/api/v1/identities/*` - Identity management
|
||||
|
||||
### MarkBase API (v2)
|
||||
|
||||
- `/api/v2/admin/*` - Admin operations
|
||||
- `/api/v2/myfiles/*` - File storage
|
||||
|
||||
### Studio Proxy (8888)
|
||||
|
||||
- Gateway for v1 and v2 APIs
|
||||
- Local SQLite for history/bookmarks
|
||||
- Face thumbnail generation
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
### User Documentation
|
||||
|
||||
- **Changelog**: `CHANGELOG.md`
|
||||
- **Installation Guide**: `RELEASE_v0.1.0_INSTALLATION_GUIDE.md`
|
||||
- **Architecture**: `docs/ARCHITECTURE.md`
|
||||
|
||||
### Developer Documentation
|
||||
|
||||
- **Agent Guide**: `AGENTS.md`
|
||||
- **API Reference**: `docs_v1.0/GUIDES/API_REFERENCE.md`
|
||||
- **Quick Start**: `docs/Quick_Implementation_Checklist.md`
|
||||
|
||||
---
|
||||
|
||||
## Deployment
|
||||
|
||||
### Production (m5max48)
|
||||
|
||||
```bash
|
||||
# Access: https://studio.momentry.ddns.net
|
||||
|
||||
# SSH deployment
|
||||
ssh accusys@m5max48
|
||||
cd /Users/accusys/momentry_studio
|
||||
git pull origin main
|
||||
npm install
|
||||
npm run build
|
||||
pkill -f momentry-proxy
|
||||
npm run proxy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
Create `.env` file:
|
||||
|
||||
```env
|
||||
MOMENTRY_API_URL=http://localhost:3002
|
||||
MOMENTRY_API_KEY=your_api_key_here
|
||||
MARKBASE_API_URL=http://localhost:11438
|
||||
DATABASE_URL=postgres://accusys@localhost:5432/momentry
|
||||
QDRANT_URL=http://localhost:6333
|
||||
```
|
||||
|
||||
### Tauri Configuration
|
||||
|
||||
Edit `src-tauri/tauri.conf.json` for desktop app settings.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Port 8888 in Use
|
||||
|
||||
```bash
|
||||
lsof -i :8888
|
||||
kill -9 <PID>
|
||||
npm run proxy
|
||||
```
|
||||
|
||||
### Build Errors
|
||||
|
||||
```bash
|
||||
# Clean and rebuild
|
||||
npm run build
|
||||
cd src-tauri && cargo clean && cargo build --release
|
||||
```
|
||||
|
||||
### No Search Results
|
||||
|
||||
```bash
|
||||
# Check Core API
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# Check database
|
||||
psql -d momentry -c "SELECT COUNT(*) FROM videos;"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Support
|
||||
|
||||
- **Issues**: https://github.com/anomalyco/momentry_studio/issues
|
||||
- **Internal Git**: http://localhost:3000/admin/momentry_studio
|
||||
- **Logs**: `logs/studio.log`, `/tmp/momentry_proxy.log`
|
||||
|
||||
---
|
||||
|
||||
## Version History
|
||||
|
||||
### v0.1.0 (2026-10-11)
|
||||
|
||||
- ✅ Search pagination with "Load More" button
|
||||
- ✅ Library displays 118 files correctly
|
||||
- ✅ Scene VLM status visualization
|
||||
- ✅ Advanced Mode toggle
|
||||
- ✅ Complete architecture documentation
|
||||
|
||||
See `CHANGELOG.md` for full history.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
Proprietary - Momentry Studio Team
|
||||
|
||||
---
|
||||
|
||||
## Team
|
||||
|
||||
- **Development**: Momentry Studio Team
|
||||
- **Release**: Production v0.1.0
|
||||
|
||||
---
|
||||
|
||||
**Project Status**: ✅ Production Ready
|
||||
|
||||
**Next Release**: v0.2.0 (WebSocket, Session API, Resumable Upload)
|
||||
Reference in New Issue
Block a user