--- 项目声明 本仓库源码基于 MIT 协议开源,可用于学习、研究、二次开发以及商业部署。 开源版本不包含任何真实的生产密钥。提交代码前请确认未提交 .env、真实的 API 密钥、令牌、密码、内部地址、nodemodules、dist、.DSStore、.trae 等文件。
--- 项目声明 本仓库源码基于 MIT 协议开源,可用于学习、研究、二次开发以及商业部署。 开源版本不包含任何真实的生产密钥。提交代码前请确认未提交 .env、真实的 API 密钥、令牌、密码、内部地址、nodemodules、dist、.DSStore、.trae 等文件。
本仓库源码基于 MIT 协议 开源,可用于学习、研究、二次开发以及商业部署。
开源版本不包含任何真实生产密钥。提交代码前请确认没有提交 .env、真实 API key、token、密码、内部地址、node_modules、dist、.DS_Store、.trae 或 .venv。
从作品规划、章节拆分到正文编辑,nspox 提供围绕长篇创作流程设计的工作台,帮助作者集中管理项目结构和创作状态。
平台内置作品管理、章节管理、AI 辅助、素材组织、协作编辑和后台管理等能力,适合小说、剧本、设定集和长文档创作场景。
编辑器面向连续写作和结构化创作场景,支持章节化内容管理,并与 AI 写作、素材上下文和协作能力配合使用。
AI 能力可用于续写、润色、分析、总结和灵感生成。具体模型供应商由本地环境变量配置,仓库不会提供真实 API key。
nspox 适用于个人写作、团队共创、世界观设定、长篇内容管理和私有化 AI 写作实验等场景。
| 模块 | 技术 | 默认端口 |
|---|---|---|
backend/ |
FastAPI + Python 3.10+ + Poetry + SQLAlchemy async | 8000 |
frontend/ |
React 19 + TypeScript + Vite + TipTap/Yjs | 5173 |
admin/ |
React 18 + Ant Design + Vite | 5174 |
docker/ |
PostgreSQL, Redis, MongoDB, MinIO, optional Qdrant/Neo4j | service ports |
当前本地推荐后端入口是:
poetry run uvicorn memos.api.ai_api:app --host 0.0.0.0 --port 8000 --reloadnspox/
├── frontend/ # 用户端前端,Vite dev server: http://localhost:5173
├── admin/ # 管理后台,Vite dev server: http://localhost:5174
├── backend/ # FastAPI 后端,API docs: http://localhost:8000/docs
├── docker/ # Docker Compose、Nginx、PostgreSQL 初始化 SQL
├── deploy/ # 部署辅助文件和历史数据导出
├── docs/ # 项目文档
└── start.sh # 历史一键启动脚本;推荐命令以 docs/getting-started.md 为准| 目标 | 文档 |
|---|---|
| 新人本地启动 | docs/getting-started.md |
| 环境变量和配置项 | docs/configuration.md |
| 服务器部署 | docs/deployment.md |
| 开发协作、测试、PR 检查 | docs/development.md |
| 后端单独说明 | backend/README.md |
完整步骤见 快速开始。最短路径如下,命令默认从仓库根目录执行。
cp docker/.env.example docker/.env
cp backend/.env.example backend/.envdocker compose --env-file docker/.env -f docker/docker-compose.infra.yml -p nspox up -d postgres redis mongodb miniocd backend
poetry install --extras all --with dev --with test
export PYTHONPATH="$PWD/src"
poetry run uvicorn memos.api.ai_api:app --host 0.0.0.0 --port 8000 --reloadcd frontend
npm ci
npm run devcd admin
npm ci
npm run dev访问地址:
| 服务 | 地址 |
|---|---|
| Backend docs | http://localhost:8000/docs |
| Frontend 用户端 | http://localhost:5173 |
| Admin 管理后台 | http://localhost:5174 |
注册需要邀请码。本地初始化 SQL 已包含未使用的邀请码种子,查询方式见 docs/getting-started.md。
负责人部署服务器前请先阅读 docs/deployment.md。生产环境必须显式设置:
ENVIRONMENT=productionSECRET_KEYBACKEND_CORS_ORIGINS JSON 数组ALLOWED_HOSTS JSON 数组生产环境不能使用 example-placeholder-do-not-use 或任何弱口令占位符。
.env 只在本机或服务器保存,不提交到 Git。backend/.env.example 和 docker/.env.example 只能保留占位符。BACKEND_CORS_ORIGINS 和 ALLOWED_HOSTS 必须使用 JSON 数组格式。暂无开放 Issues,或尚未同步最近议题。