README.md

Notion-Clone Browser Client

The Notion-Clone Frontend is a TypeScript-based React application that complements the robust backend API. It offers a user interface and experience similar to the popular note-taking and collaboration application, Notion. This frontend is designed to work seamlessly with the backend API, handling user authentication and authorization, while providing a wide range of functionalities for creating, managing, and collaborating on various types of content, such as supercharged tables, multimedia, lists etc.

By adhering to best practices in frontend development, the Notion-Clone application employs TypeScript to ensure type safety and improve code quality. The React framework enables building interactive and responsive user interfaces, enhancing the overall user experience.

Demo Video:

https://www.youtube.com/watch?v=XkFgv8AsUe0&t=13s

Detail Blog:

https://shreyasmanolkar.hashnode.dev/building-notion-clone-part-2-crafting-the-front-end-experience

Features

• User Authentication: Secure user registration and login processes with hashed passwords and token-based authentication.
• Authentication using HTTP only cookies.
• Content Creation and Management: Create, update, and delete various content types, including notes, lists, media, superchared tables, task lists etc.
• Collaboration: Enable users to collaborate on shared content, providing granular access control and permissions.
• Rich Text Support: Allow users to create and edit content with rich text formatting options.
• Security: Ensure data security and privacy with robust authentication and authorization mechanisms.
• upload images for profile picture, cover photo and in text editor.
• slash menu
• bubble menu
• light / dark mode
• unsplash api integration

Notion Like Text Editor

This repository hosts a custom text editor that draws inspiration from Notion's rich editing capabilities. The editor enables users to effortlessly create and organize diverse types of content, such as paragraphs, headings, lists, tables, images, videos, toggles, and more, with an intuitive drag-and-drop functionality.

ProseMirror Library:

The heart of this text editor is powered by ProseMirror, a collection of open-source JavaScript libraries specifically designed for handling rich text editing within web browsers. ProseMirror abstracts away browser inconsistencies, particularly those related to the contenteditable attribute, which browsers rely on for text editing. This ensures a consistent and smooth editing experience across various browsers, even in modern ones like Google Chrome.

ProseMirror provides a set of straightforward primitives to work with, including:

Document:

Represented by a node, the main document contains one or more children, each of which can have their own children and attributes.

Selection:

Represented by a selection class, it handles interpreting input events like paste, key presses, and selections consistently across different browsers.

Transforms and Transactions:

Represent changes to the document, making it easy to apply and track modifications.

The library introduces a node-based approach to represent various elements, such as paragraphs, headings, images, and more. These elements can have associated features like sizes, placeholders, and draggability. For instance, paragraph nodes contain a flat sequence of inline elements, each with its own set of styles. This allows ProseMirror to track each node's position based on character offsets, making it easy to select, find, and work with specific elements.

Tiptap Extension:

To simplify the usage of ProseMirror and accelerate development, our text editor leverages Tiptap, an extension framework built on top of ProseMirror. Tiptap provides a high-level abstraction that streamlines common editor tasks, such as managing the editor's state, handling commands, and rendering content in the DOM.

By combining ProseMirror with Tiptap, we enhance the text editor's usability and development experience. Tiptap offers a wealth of pre-built features and extensions that make it straightforward to incorporate modern functionalities like multimedia support, tables, to-do lists, and markdown formatting.

With Tiptap's intuitive interface and seamless integration with ProseMirror, it was efficient to focus on building a robust and user-friendly text editor while minimizing the complexities of working directly with the underlying ProseMirror library.

this Notion-like text editor is, powered by the ProseMirror library and enriched with the simplicity and power of Tiptap extensions. Experience a seamless and feature-rich text editing experience that takes inspiration from Notion's innovative content organization and collaboration capabilities.

Run Locally

Create notion-clone directory

  mkdir notion-clone

Go to the project directory

  cd notion-clone

Clone the browser client project adjacent to notion-api

  git clone [email protected]:shreyasmanolkar/notion-browser-client.git

Go to the project directory

  cd notion-borwser-client

Install dependencies

  npm install

Create .env file

  cp .env-example .env

Start the server

  npm run start

Running Tests

To run tests, run the following command

  npm run test

To run test coverage report, run the following command

  npm run coverage

Demo

Cover Photo:

simplescreenrecorder-2023-07-22_16.15.58.mp4

New Workspace:

simplescreenrecorder-2023-07-22_17.01.56.mp4

Settings Panel:

simplescreenrecorder-2023-07-22_15.51.04.mp4

Favorites:

simplescreenrecorder-2023-07-22_16.53.39.mp4

Custom Text Editor:

simplescreenrecorder-2023-07-22_16.11.20.mp4

Workspace Switch:

simplescreenrecorder-2023-07-22_17.03.01.mp4

New Page:

simplescreenrecorder-2023-07-22_15.58.53.mp4

Search:

simplescreenrecorder-2023-07-22_17.06.02.mp4

unsplash API:

simplescreenrecorder-2023-07-22_16.34.25.mp4

Upload:

simplescreenrecorder-2023-07-22_16.27.44.mp4

Profile Picture:

simplescreenrecorder-2023-07-22_17.04.51.mp4

Theme:

simplescreenrecorder-2023-07-22_19.58.54.mp4

Responsive Design:

simplescreenrecorder-2023-07-22_20.08.06.mp4

License

This project is under the MIT license . See the LICENSE for more information.