Live Docs is a collaborative document editing platform designed to streamline your workflow. Whether you're managing projects, sharing notes, or working on documents with a team, Live Docs provides real-time collaboration, a robust folder and document management system, and an intuitive user experience.
- Collaborative Editing: Work on documents simultaneously with team members using real-time updates.
- Folder and Document Management: Organize your content with support for folders, subfolders, and document structures.
- User Roles and Permissions: Control who can view, edit, or manage documents with customizable permissions.
- Real-Time Notifications: Stay updated on changes, comments, and alerts instantly.
- Responsive Design: Seamlessly use the app across devices.
The project is built with the following technologies:
- Next.js: A powerful React framework for server-side rendering and static site generation.
- Shadcn & Tailwind CSS: A combination of UI components and utility-first styling for a clean and responsive design.
- TypeScript: For strong type safety and enhanced developer experience.
- MongoDB: A NoSQL database to store user data, folders, and documents efficiently.
-
Clone the repository:
git clone https://github.com/MOHAMED-EHAB-DEV/live-docs.git cd live-docs -
Install dependencies:
npm install
-
Set up your .env file with the required variables:
LIVEBLOCKS_SECRET_KEY=YOUR-LIVEBLOCKS-TOKEN SENTRY_AUTH_TOKEN=YOUR-SENTRY-TOKEN NEXT_PUBLIC_URL=http://localhost:3000 NEXTAUTH_URL=http://localhost:3000 NEXTAUTH_SECRET=YOUR-SECRET GOOGLE_CLIENT_ID=YOUR-GOOGLE-CLIENT-ID MONGODB_URI=YOUR-MONGODB-URI UPLOADTHING_TOKEN=YOUR-UPLOAD-THING-TOKEN
-
Start the development server:
npm run dev
-
Visit the app in your browser at http://localhost:3000.
Contributions are welcome! Feel free to open issues or submit pull requests to improve the app. Make sure to follow the contribution guidelines.
This project is licensed under the MIT License.
Developed with ❤️ using Next.js, Tailwind CSS, TypeScript, and MongoDB.