Summary

nspox is an open-source AI-powered writing platform designed to help creators build and share their "inner worlds." It targets writers, novelists, and scriptwriters, offering a collaborative environment that simplifies the creative process and enhances storytelling through AI assistance.

How It Works

nspox utilizes a modern tech stack featuring a React/TypeScript frontend and a FastAPI backend. Its core innovation lies in combining a TipTap-based rich text editor with Yjs CRDT for seamless, real-time, multi-user collaborative writing. AI assistance, compatible with OpenAI APIs (e.g., DeepSeek) and Ollama, is directly integrated into the editor for content generation and refinement. Optional Neo4j and Qdrant databases extend functionality with advanced memory and semantic search capabilities.

Quick Start & Requirements

Prerequisites include Node.js 20+, npm 10+, Python 3.10+, and Docker with Docker Compose. Installation involves cloning the repository, starting core infrastructure services (PostgreSQL, Redis, MongoDB) via Docker Compose, configuring backend environment variables (including API keys), and running the frontend and backend development servers. A start.sh script provides a one-click setup. API documentation is accessible at http://localhost:8001/docs.

Highlighted Details

• AI-powered writing assistant integrated into an immersive, TipTap-based editor supporting novel and script formats.
• Real-time, multi-user collaboration powered by Yjs CRDT technology.
• Optional advanced features include a multi-layer memory system (Neo4j) and semantic search (Qdrant).
• Supports OpenAI-compatible AI APIs and Ollama for flexible AI model integration.

Maintenance & Community

The project provides links to its GitHub repository, issues, and discussions for community engagement. No specific details regarding active maintainers, sponsorships, or dedicated community channels (like Discord/Slack) are present in the README.

Licensing & Compatibility

The project is licensed under the MIT License. This permissive license allows for use in learning, research, secondary development, and commercial deployment without requiring additional authorization, provided the license terms are followed.

Limitations & Caveats

Advanced features such as the memory system (Neo4j) and semantic search (Qdrant) depend on optional database configurations. Production deployment guidance primarily relies on Docker Compose, necessitating specific environment variable setup. The README does not provide performance benchmarks or detailed hardware requirements beyond standard development tools.