Skip to content

kmr-ankitt/szare

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Szare

Szare is a fast and offline file-sharing application that requires zero configuration.

image

Features

  • 🌐 Self hosted
  • 🚀 High-speed local network transfers
  • 📱 Modern web interface
  • 📦 Support for large files (>1GB)
  • 📂 Directory navigation
  • 📊 Real-time progress tracking

Quick Installation

  • Currently only Supports Linux systems 🐧

  • Ensure that nodejs is installed on your system.

To install Szare, run the following command:

curl -sSL https://raw.githubusercontent.com/kmr-ankitt/szare/main/install.sh | bash

Usage Instructions

  1. Start the Application:

    • If you installed Szare using the quick installation method, simply run the following command to start the application:
      szare
    • If you built Szare manually, ensure you are in the project directory and run:
      make run
  2. Sharing Files:

    • All the files from the directory you started the application in are shared.
    • If you want to share from your other devices then you can upload files from the web interface and It will be downloaded to the directory you started the application in.
  3. Receiving Files:

    • Other devices on the same local network can access the shared files by scanning the QR code presented at the terminal or navigating to http://<your-local-ip>:3002 in their web browser.
    • They can browse the available files and download them as needed.
  4. Real-time Progress Tracking:

    • The web interface provides real-time progress tracking for both uploads and downloads, allowing you to monitor the status of your file transfers.

Manual Build

To manually build Szare, ensure you have the following dependencies installed:

  • Go
  • Node.js
  • npm

Clone the repository and navigate to the project directory:

git clone https://www.github.com/kmr-ankitt/szare
cd szare

Build the backend and frontend components:

make build

Run the application:

make run

Uninstallation

To uninstall Szare, run the following command:

curl -sSL https://raw.githubusercontent.com/kmr-ankitt/szare/main/uninstall.sh | bash

About

Offline File Sharing application

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published