https://github.com/dev-sire/collabdoc
Your online workspace. Brainstorm, write, and edit together in real time with CollabDocs.
https://github.com/dev-sire/collabdoc
clerkauth lexical liveblocks nextjs14 shadcn-ui tailwindcss typescript
Last synced: 3 months ago
JSON representation
Your online workspace. Brainstorm, write, and edit together in real time with CollabDocs.
- Host: GitHub
- URL: https://github.com/dev-sire/collabdoc
- Owner: dev-sire
- License: apache-2.0
- Created: 2024-08-06T18:05:52.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T17:54:40.000Z (10 months ago)
- Last Synced: 2025-01-29T09:41:10.032Z (5 months ago)
- Topics: clerkauth, lexical, liveblocks, nextjs14, shadcn-ui, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://collabdocs-devsire.vercel.app
- Size: 1.21 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CollabDocs: Your Real-time Text Editor
Experience the future of document collaboration. CollabDocs offers a seamless and intuitive platform for teams to work together on projects of any size.
### Tech Stack
**Frontend:**
- Next.js
- TypeScript
- Tailwind CSS
- Shadcn
- Lexical Editor
**Backend:**
- Liveblocks
- Clerk
### Getting Started
**Prerequisites:**
- Node.js and npm (or yarn) installed
- Basic understanding of Next.js, TypeScript, and React
- Accounts for Liveblocks & Clerk.
**Installation:**
1. Clone the repository:
```git clone https://github.com/dev-sire/CollabDoc.git```
2. Navigate to the project directory:
```cd CollabDoc```
3. Install dependencies:
```npm install```
4. Set up environment variables:
- Create a ```.env.local``` file at the root of the project.
- Follow the [quick setup](https://liveblocks.io/docs/get-started/nextjs) guide provided by Liveblocks
- Add your Clerk & Liveblock API keys.
### Contributing
Your contributions help make CollabDocs even better. Whether you're a seasoned developer or just starting out, your help is appreciated.
### License
CollabDocs is licensed under the MIT License. See the ```LICENSE``` file for details.