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
- Clone the Repository:
git clone https://github.com/SujalMatolia0/xpad.git
- Install Dependencies:
(or
cd xpad npm install
yarn install
if using yarn)
Development Setup
- Start the Development Server:
(or
npm start
yarn start
) This will typically launch the application athttp://localhost:3000
(or a custom port you might have configured).
Usage
- Start Writing: Create new documents or open existing ones to begin composing your text.
- Collaborate: Share your documents with others and work together in real-time, fostering efficient teamwork.
- Track Changes: Utilize the version control system to review and revert to previous versions of your documents when needed.