Skip to content

SujalMatolia0/xpad

Repository files navigation

XPAD: A Collaborative Text Editor

Project Overview

XPAD is a web-based collaborative text editor designed to provide a seamless writing experience for individuals and teams. Inspired by popular online editors, XPAD offers powerful features for composing, sharing, and editing text in real-time.

Key Features

  • Rich Text Editing: Create and edit documents with the ease of a familiar text editor, including formatting options like bold, italics, and headings.
  • Real-time Collaboration: Work simultaneously with others on the same document, seeing changes instantly as they're made.
  • Version Control: Track changes to your documents over time and revert to previous versions if necessary.
  • Database Integration: Store and access your documents securely within a database (specify the database you're using, e.g., PostgreSQL, MySQL).
  • Amntine Integration: (Optional) For advanced users, leverage Amntine's rich text editing capabilities if it's part of your project.

Technology Stack

  • Frontend: T3 Stack (Tailwind CSS, TypeScript, and potentially React or another JavaScript framework)
  • Backend: Drizzle (for state management and data fetching)
  • Database: (Specify the database you're using)

Installation

  1. Clone the Repository:
    git clone https://github.com/SujalMatolia0/xpad.git
  2. Install Dependencies:
    cd xpad
    npm install
    (or yarn install if using yarn)

Development Setup

  1. Start the Development Server:
    npm start
    (or yarn start) This will typically launch the application at http://localhost:3000 (or a custom port you might have configured).

Usage

  1. Start Writing: Create new documents or open existing ones to begin composing your text.
  2. Collaborate: Share your documents with others and work together in real-time, fostering efficient teamwork.
  3. Track Changes: Utilize the version control system to review and revert to previous versions of your documents when needed.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published