Skip to content

hsaab/MDocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Magic Docs

App can be viewed by using electron. To start the app, please do the following:

  1. git clone the repository
  2. npm install --save
  3. Create .env file and set URI of MongoDB database equal to environmental variable mongodb_uri
  4. npm run dev

Sign Up & Login

When users first start the app, they are directed to the home screen with optionality to sign up or log in. Upon hitting "Sign Up", new user can enter desired username and password. Then, the user is redirected to login on the login page. Using Passport authentication, the user can login and access the main portal!

Creating New Docs

Upon logging in, the user has the ability to create new documents which persist in MongoDB. Upon creating a document, we can edit the document, as well as add custom styling courtesy of Draft.js.

Sharing Docs

In order to share docs, one user needs to send the other user the unique document ID, which is located in the top left corner.

The second user will input the document ID on the main portal page and press submit.

Now, the second user can update the document in real-time thanks to socket.io!

About

React text-editor desktop application built on Electron with secure collaborative features

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors