Skip to content

About DraftShare is a web application designed to make PDF management and collaboration effortless. It allows users to sign up, upload PDFs, share them with others, and collaborate through comments

Notifications You must be signed in to change notification settings

JasonDsouza212/sharedraft

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

📁 DraftShare

Sharing Contracts Made Easy

Homepage of DraftShare

Welcome to DraftShare

DEMO

Watch Video Demo - Learn how DraftShare works.

📝 About

DraftShare is a web application designed to make PDF management and collaboration effortless. It allows users to sign up, upload PDFs, share them with others, and collaborate through comments.

🧰 Features

  • Upload and view PDFs.
  • Collaborate on PDFs by adding comments.
  • Share PDFs with workspace users.
  • View and comment on shared PDFs.
  • Easily search for contracts.
  • User authentication and authorization with JWT.
  • Unauthorized users can view PDFs via a shared link but need access to view comments.
  • Rename files for easier tracking.
  • Input validation ensures a smooth experience.
  • Beautiful and intuitive UI for collaboration.

🛠️ Tech Stack

This project uses:
React
Tailwind
NPM
MongoDB
Express
NodeJS

Prerequisites

Before installation, ensure you have the following installed or have knowledge of:

React
NodeJS
Git

🤝 Contributing

Running This Project Locally

Backend Setup:

  1. Clone the main branch to your local machine:

    git clone https://github.com/JasonDsouza212/sharedraft.git
  2. Navigate to the project directory:

    cd sharedraft
  3. Navigate to the backend directory:

    cd server
    
  4. Set the .env file with the following values in the backend folder:

    .env
    
    PORT=**4000**
    MONGO_URI=**Your MongoDB URL**
    SECRET=**"BASE64 ENCODED string"**
    REACT_HASH_KEY=**"BASE 64 string"**
    SERVER_BASE_URL="**Your server URL or localhost:4000"**
    
  5. Install npm packages:

    npm install
    
  6. Run the backend locally:

    npm start
    

Frontend Setup:

  1. Navigate to the frontend directory:

    cd client
    
  2. Set the .env file with the following values:

    .env
    
    VITE_REACT_HASH_KEY= Your BASE64 HASH (must match the server's HASH)
    VITE_SERVER_BASE_URL= Server base URL or localhost:4000 for development
    
  3. Install npm packages:

    npm install
    
  4. Run the frontend locally:

    npm run dev
    
  5. You can access the application at:

    http://localhost:5173/
    

Note:

  1. No 3rd party service is used to upload the PDF file , it has been uploaded directly to mongoDB as chuncks

About

About DraftShare is a web application designed to make PDF management and collaboration effortless. It allows users to sign up, upload PDFs, share them with others, and collaborate through comments

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published