Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kmr-ankitt/szare
Offline File Sharing application
https://github.com/kmr-ankitt/szare
gin sharing
Last synced: about 14 hours ago
JSON representation
Offline File Sharing application
- Host: GitHub
- URL: https://github.com/kmr-ankitt/szare
- Owner: kmr-ankitt
- License: mit
- Created: 2024-12-15T15:00:08.000Z (11 days ago)
- Default Branch: main
- Last Pushed: 2024-12-25T04:00:29.000Z (1 day ago)
- Last Synced: 2024-12-25T05:17:41.754Z (1 day ago)
- Topics: gin, sharing
- Language: TypeScript
- Homepage:
- Size: 41.1 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Szare
Szare is a fast and offline file-sharing application that requires zero configuration.
## 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:
```bash
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:
```bash
szare
```
- If you built Szare manually, ensure you are in the project directory and run:
```bash
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://: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:
```bash
git clone https://www.github.com/kmr-ankitt/szare
cd szare
```
Build the backend and frontend components:
```bash
make build
```
Run the application:
```bash
make run
```
## Uninstallation
To uninstall Szare, run the following command:
```bash
curl -sSL https://raw.githubusercontent.com/kmr-ankitt/szare/main/uninstall.sh | bash
```