<

PenSync

Collaborative Writing and Editing PLatform.

📋 Table of Contents

• About
• Tech Stack
• Features
• Quick Start

About

Collaborative Writing and Editing Platform. Easily brainstorm, contribute, and collaborate with your team on any writing project.

Tech Stack

• Next.js
• TypeScript
• LiveBlocks
• Tailwind CSS
• Shadcn-ui
• Clerk-auth

Features

☑️ Collaborative Text Editor: Multiple users can edit the same document simultaneously with real-time updates.

☑️ Documents Management

• Create Documents: Users can create new documents, which are automatically saved and listed.
• Delete Documents: Users can delete documents they own.
• Share Documents: Users can share documents via email or link with view/edit permissions.
• List Documents: Display all documents owned or shared with the user, with search and sorting functionalities.

☑️ Comments: Users can add inline and general comments, with threading for discussions.

☑️ Active Collaborators on Text Editor: Show active collaborators with real-time presence indicators.

☑️ Notifications: Notify users of document shares, new comments, and collaborator activities.

☑️ Responsive: The application is responsive across all devices.

and many more, including code architecture and reusability

Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Git
• Node.js
• npm (Node Package Manager)

Cloning the Repository

git clone https://github.com/techy-savant/PenSync
cd PenSync

Installation

Install the project dependencies using npm:

npm install

Set Up Environment Variables

Create a new file named .env in the root of your project and add the following content:

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY=
NEXT_PUBLIC_LIVEBLOCKS_SECRET_KEY=

Running the Project

npm run dev

Open http://localhost:3000 in your browser to view the project.