Skip to content

frontend for SynchroDocs, a collaborative online document editor built with React, Quill.

Notifications You must be signed in to change notification settings

ujjwal-bh/synchrodocs-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SynchroDocs-UI

This is the frontend for SynchroDocs, a collaborative online document editor. The frontend is built with React and uses Quill for rich text editing. backend: https://www.github.com/ujjwal-bh/synchrodocs-api

Features

  • Real-time collaborative editing
  • Rich text formatting with Quill
  • User authentication and authorization
  • Document sharing with various permission levels

Prerequisites

Ensure you have the following installed on your system:

  • Node.js (v12.x or later)
  • npm (v6.x or later)

Steps

  1. Navigate to the frontend directory:

    cd synchrodocs-ui
  2. Install the dependencies:

    npm install
  3. Set up environment variables:

    Create a .env file in the synchrodocs-ui directory and add any necessary environment variables.

  4. Start the development server:

    npm start

    The frontend application should now be running on http://localhost:3000.

Usage

  1. Sign Up / Login: Create a new account or log in with your existing credentials.
  2. Create a Document: Click on 'New Document' to create a new document.
  3. Edit and Format: Use the Quill-based toolbar to format text, add headings, lists, links, and more.
  4. Share: Click on the 'Share' button to invite others to view or edit the document.

Dependencies

  • React
  • Quill
  • other

Contact

For any questions or issues, please open an issue in the repository or contact at [email protected].

About

frontend for SynchroDocs, a collaborative online document editor built with React, Quill.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages