readme.md

DocuSync

A collaborative text editor desktop application designed for seamless teamwork.

Some of the key features

• User authentication
• Real-time collaboration
• Real-time Chatting support
• Only authorized users can edit or access specific documents
• MongoDB integration for storing the documents
• Supports Windows, MacOS, and Linux as well

Home Page

Workspace Page

Demo

Build from Source Code

Clone the repo

git clone https://github.com/kanhaiya04/DocuSync.git
cd DocuSync/

Use the npm package manager to install dependencies

Electron dependencies:

cd client/
npm install

Note: Update the host url in React components to - https://docusyncbackend.onrender.com

Install React dependencies:

cd client/app
npm install

Build app from react components

cd client/app
npm run build

Build DocuSync from source code for your platform

cd client/
npm run make

Once the build process is successfully completed, you will find the installation package in the "out" folder.

Run from source code for development

Clone the repo

git clone https://github.com/kanhaiya04/DocuSync.git
cd DocuSync/

Create and configure .env file

touch .env
cp .env.sample .env

update the values in the .env file

Use the npm package manager to install dependencies

Install express dependencies:

cd server/
npm install

Run the express server

cd server/
node index

Install react dependencies:

cd client/app
npm install

Build the app from components

cd client/app
npm run build

Install electron dependencies:

cd client/
npm install

Run the electron app locally

cd client/
npm start

Now you are good to make contributions to the code base.