README.md

metadata

title: RM Research Assistant
emoji: 🧬
colorFrom: indigo
colorTo: blue
sdk: docker
app_port: 8000
pinned: false
license: mit

RM Research Assistant

AI-powered scholarly research platform for institutional research management.

🚀 Features

• 🔍 Advanced Search: Vector-powered academic paper discovery
• 🧠 AI Intelligence: Groq-powered research assistance
• 📚 Library Management: Personal and institutional paper collections
• 🔐 Institutional SSO: SAML 2.0 integration for universities
• 💳 Payment Processing: Premium subscription management
• 🧬 Clinical Extraction: PICO trial data extraction
• 🗺️ Discovery Maps: High-scale research visualization
• 🛡️ Veritas Shield: Originality and integrity checking
• 📝 WriteSage: Automated manuscript composition
• 🧪 DataPure: Professional data cleaning services

🏗️ Architecture

• Frontend: Next.js 14+ (App Router) with Atomic Design architecture
• Backend: FastAPI with Python 3.11+
• Database: Oracle 23ai (relational + vector)
• Vector Store: Milvus for semantic search
• Cache: Redis for session management
• Authentication: JWT + SAML 2.0
• Containerization: Docker with multi-stage builds
• AI Engines: Groq LPU (Llama 3.1) & WebLLM (Qwen 1.5B)

📂 Frontend Structure (Atomic Design)

The frontend is organized into 45 core files across five layers:

• Atoms: Fundamental UI primitives (Buttons, Badges, Spinners)
• Molecules: Compound units (PaperCards, SearchBars, StatCards)
• Organisms: Functional modules (PicoForm, Sidebar, Header)
• Templates: Standardized dashboard layouts
• Infrastructure: Type-safe api-client, useApi hooks, and Unified AuthGuard

📋 Prerequisites

• Python 3.11 or higher
• Node.js 18.x or higher & npm/pnpm
• Oracle Database 23ai with Vector support
• Milvus Vector Database
• Redis server
• Docker & Docker Compose

🚀 Quick Start

1. Environment Setup

# Clone the repository
git clone [https://github.com/rm-research/rm-research-assistant.git](https://github.com/rm-research/rm-research-assistant.git)
cd rm-research-assistant

# Copy environment template
cp .env.example .env

# Edit .env with your configuration (Include GROQ_API_KEY)
nano .env