Skip to content

README.md

Latest commit

 

History

History
86 lines (58 loc) · 1.82 KB

README.md

File metadata and controls

86 lines (58 loc) · 1.82 KB

image

🚀 Cross-Device File Sharing Tool (ShareHub)

A simple and efficient file and text-sharing tool designed to work seamlessly across devices.

🌟 Overview

ShareHub allows you to share text and files between devices using a simple URL. The platform provides an intuitive interface to quickly save and access shared content.

🎯 Features

  • ✅ Text Sharing: Easily share text via a custom URL.
  • ✅ File Upload: Upload files and generate a sharable link.
  • ✅ Cross-Device Compatibility: Access shared content on any device.
  • ✅ Custom URL Support: Option to define your own URL for easy sharing.
  • ✅ Secure: Data transmission is encrypted for security.

🛠️ Tech Stack

  • Frontend: React.js
  • Backend: Node.js (Express)
  • Database: MongoDB
  • Styling: Tailwind CSS
  • Deployment: Docker

🚀 Getting Started

  1. Clone the Repository
git clone https://github.com/musharafmaqbool/Cross-Device-File-Sharing-Tool.git
cd Cross-Device-File-Sharing-Tool
  1. Install Dependencies For backend:
npm install

For frontend:

cd client
npm install
  1. Create .env File Create a .env file in the root and add:
MONGO_URI = your_mongodb_connection_string
PORT = 5000
  1. Run the Project Start backend:
npm run server

Start frontend:

cd client
npm start
  1. Access the App Open http://localhost:3000 in your browser.

🚧 Known Issues

  • Files over 100MB may not upload correctly.
  • Long custom URLs may fail to generate.

🤝 Contributing

Feel free to open issues or submit pull requests to improve the project.


Is there a specific part of the formatting you want me to adjust further?