{"id":25923916,"url":"https://github.com/thaminiperera/docs","last_synced_at":"2026-04-15T14:03:50.208Z","repository":{"id":279555058,"uuid":"930823634","full_name":"thaminiperera/docs","owner":"thaminiperera","description":"A real-time, collaborative document editing platform with secure authentication, and data synchronization.","archived":false,"fork":false,"pushed_at":"2025-05-27T16:29:56.000Z","size":794,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-27T17:33:24.700Z","etag":null,"topics":["clerk","convex","nextjs","tiptap-editor","vercel"],"latest_commit_sha":null,"homepage":"https://docs-five-orpin.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thaminiperera.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-11T09:18:48.000Z","updated_at":"2025-05-27T16:29:59.000Z","dependencies_parsed_at":"2025-02-26T07:40:51.026Z","dependency_job_id":null,"html_url":"https://github.com/thaminiperera/docs","commit_stats":null,"previous_names":["thaminiperera/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thaminiperera/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thaminiperera%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thaminiperera%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thaminiperera%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thaminiperera%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thaminiperera","download_url":"https://codeload.github.com/thaminiperera/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thaminiperera%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27355544,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-29T02:00:06.589Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clerk","convex","nextjs","tiptap-editor","vercel"],"created_at":"2025-03-03T17:18:50.041Z","updated_at":"2025-11-29T15:02:34.953Z","avatar_url":"https://github.com/thaminiperera.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Real-Time Document Editing \u0026 Collaboration Platform\n\nThis system provides a fluid, responsive, and feature-rich document editing and collaboration environment. It offers a modern alternative to traditional tools like Google Docs, enabling users to create, edit, and collaborate on documents in real-time with minimal latency. The platform is highly customizable, catering to the evolving needs of modern users.\n\nApplication Demo :  https://docs-five-orpin.vercel.app\n\n---\n\n## Key Features\n\n- **Real-time Document Collaboration:** Multiple users can collaborate seamlessly with real-time updates, live cursor tracking, and synchronized changes.\n- **Customizable Document Editing:** Features a flexible text editor with support for advanced formatting, tables, task lists, image embedding, and more.\n- **Secure Authentication \u0026 Access Management:** Ensures secure logins, user authentication, and organizational access control.\n- **Template Library:** A variety of pre-designed templates (business letters, resumes, etc.) for easier document creation.\n- **Dynamic UI:** Intuitive and responsive user interface optimized for multiple devices.\n\n---\n\n## Technologies \u0026 Services\n\n- **TipTap Editor:** A rich-text editor supporting customizable text formatting and advanced features like tables, image embedding, task lists, and more.\n- **Liveblocks:** Enables real-time synchronization, user presence tracking, and collaboration features such as comments and mentions.\n- **Clerk:** A secure authentication service for managing user logins and access control.\n- **Convex:** A backend-as-a-service solution for real-time data storage and synchronization across multiple users.\n- **Next.js:** For server-side rendering and fast performance.\n- **Tailwind CSS \u0026 Shadcn:** For modern, responsive UI design.\n- **Lucide-react \u0026 React-Icons:** Clear and intuitive iconography.\n- **Toast:** For smooth, non-intrusive notifications.\n\n---\n\n## Key Features in Detail\n\n### **Rich Text Editor: TipTap Integration**\n\n- **Core Configuration:** Initialized with `useEditor` from `@tiptap/react` for optimal performance.\n- **Extensions Included:**\n  - **StarterKit:** Provides basic editing capabilities.\n  - **Advanced Styling:** Options for underline, text style, font family, color, and highlighting.\n  - **Table Support:** Create dynamic tables (cells, headers, rows).\n  - **Image and Task List Support:** Embed and resize images, manage task lists.\n  - **Text Alignment \u0026 Links:** Multiple text alignment options and seamless link embedding.\n  - **Custom Extensions:** Font size, line height, and other advanced text features.\n\n### **Real-Time Collaboration with Liveblocks**\n\n- **Presence API:** Tracks user cursor positions in real-time.\n- **Storage API:** Syncs document data, including margins and formatting.\n- **User Meta:** Displays user-specific details like name, avatar, and cursor color.\n- **Interactive Collaboration:** Supports threaded comments, mentions, and live cursor tracking.\n- **React Suspense Integration:** Provides a smooth loading experience while the editor is initialized.\n\n### **Backend \u0026 Authentication**\n\n- **Convex:** Manages document data, including titles, content, and real-time updates.\n- **Clerk:** Handles user authentication and access control, ensuring secure document sharing and editing.\n\n### **Document Templates**\n\n- A variety of pre-designed templates, such as business letters and resumes, are available for quick document creation.\n- The platform includes drag-and-drop margin controls and a dynamic ruler for precise layout adjustments.\n\n---\n\n## UI Enhancements\n\n- **Responsive Design:** Built with Tailwind CSS and Shadcn, ensuring a seamless user experience across various devices and screen sizes.\n- **Avatars:** Real-time display of user avatars for better collaboration tracking.\n- **Navbar:** A user-friendly navigation bar for managing documents, including options to create, rename, delete, and export documents in formats such as PDF, HTML, and TXT.\n- **Toolbar:** A customizable toolbar for text formatting, including bold, italics, font size, color, alignment, undo/redo, and spellcheck.\n\n---\n\n## Tech Stack\n\n- **Frontend:**  \n  - **Next.js**: For server-side rendering and fast load times.  \n  - **Tailwind CSS \u0026 Shadcn**: For responsive and stylish UI.  \n  - **Lucide-react \u0026 React-Icons**: For intuitive and clear iconography.  \n  - **Toast**: For user notifications.  \n\n- **Backend:**  \n  - **Convex**: For real-time database and API synchronization.\n\n- **Collaboration:**  \n  - **Liveblocks**: For real-time collaboration and presence tracking.\n\n- **Authentication:**  \n  - **Clerk**: For secure user authentication and access management.\n\n---\n\n## Deployment\n\nThe entire platform is deployed on **Vercel** at  https://docs-five-orpin.vercel.app\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthaminiperera%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthaminiperera%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthaminiperera%2Fdocs/lists"}