Skip to content

adabarbulescu/collabscribe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Collabscribe

Python 3.12 FastAPI React 18 Vite 5 PostgreSQL Docker Compose

Collabscribe is a real-time collaborative Markdown editor with live math rendering, version history, and built-in NLP analytics.

Highlights

  • Real-time collaborative editing with Yjs
  • Markdown preview with KaTeX math support
  • Saved document versions with diff comparison
  • NLP analytics for readability, sentiment, entities, keywords, vocabulary, and topics
  • FastAPI backend with PostgreSQL persistence
  • React + Vite frontend with Monaco Editor
  • Docker-based local setup

Stack

  • Python 3.12
  • FastAPI
  • React + Vite
  • PostgreSQL
  • Socket.IO
  • Yjs
  • Monaco Editor
  • spaCy, TextBlob, scikit-learn
  • Docker Compose

Run Locally

git clone https://github.com/adabarbulescu/collabscribe.git
cd collabscribe
cp .env.example .env
docker compose up --build -d

Open http://localhost:8000.

For frontend-only development:

cd frontend-app
npm install
npm run dev

Testing

pytest backend/tests -q
  • Yjs and snapshot unit tests run locally.
  • Versioning tests require a local PostgreSQL test database at postgresql://postgres:postgres@localhost:5432/collabscribe_test.
  • If that database is unavailable, those tests are skipped.
  • Docker builds the React frontend and serves the compiled app through FastAPI.

Notes

  • Analytics are currently tuned for English text.
  • API docs are available at /docs when the app is running.

About

Real-time collaborative Markdown editor with live math rendering, NLP analytics sidebar, and version history, built with FastAPI, React, Yjs CRDT, and PostgreSQL.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors