Describe your steps to design an online collaborative editor (eg. Google Docs)

Question

Anonymous · Accepted Answer

Step1: user login and establish a session
Function objective: user can sign in collaborative platfom
- Allow user sign up, login and authentication use JWT
- Create a session and associate with the users who are working on the file
Step 2: establish real time modification on the file
Function objective: enable multiple user to work on the file in real time
- Create web socket to persist the bi-directional communication
- Update document in real time
- Resolve conflict data modification by leverage non-conflict data type
Step 3: document storage and retrieve
Function objective: save the document and all the change history. Allow user to
search document by document name and modification criteria
- Save document in non-sql DB (mangoDB)
- Persist change history for rollback purpose
Step 4: Control conflict
Function objective: prevent same time modification get overwrite
- Implement operation transformation to prevent conflict
Step 5: version control
Function objective: keep all change history in log file for roll back and
retrive purpose
- Create log file and keep all the change history with version number, who is
modify etc
Step 6: UI
Function objective: create intuitive user interface for user
- Design UI frame use react.js for web, react native for mobile
- Add features like text editor, editor show names, real time curcor
Step 7: security and access control
Function objective: only assigned user can access the file
- User identification
- Content complaince

Anonymous · Answer

Functional:
User role:
- User login through email, apple id, face id or social media id
- User upload a file, eg, word document
- User can assign the file with file name or system will assign default name
- User can share the file link to another person through email or phone number
- An notification will send out to the person
- The recipient can modify the file, add comments. History of the iteration will
be maintained as a log
- History of who modify the file, when the file is modified will be kept in the
log
- Use can roll back to version of the file
- User commit the modification and export file as another copy
- User delete the file
- User search file by name or content
Admin role:
- Manage the user account
- Manage the modification history
- Content evaluation to keep the file in compliance
Non-functional:
Frontend:
- React native for mobile
- React for web service
- Mobile app for both ios and android
Backend:
- Use Restful API to upload file and get the file
- Node.js/response as the technology
Storage
- AWS and Azure as non-SQL database to store the file
- Metadata stored in the relational database
- Redis as cache for fast searching
Table design:
- User: userid(primary key), user name, email address, social media ID, phone,
createdon
- File: fileid(primary key), file name, userid, createdon, modifiedon,
versionnumber, modifiedby
- Modification: modificationid(primary key), modification type, modificationon,
modificationby, originalverionnumber,

Describe your steps to design an online collaborative editor (eg. Google Docs)

Practice this question with AI

Go Premium

Practice More Questions

Community Answers

Unlock Community Insights

Unlock Community Insights