Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/localsend/localsend

An open-source cross-platform alternative to AirDrop
https://github.com/localsend/localsend

dart file-sharing flutter flutter-apps

Last synced: 11 days ago
JSON representation

An open-source cross-platform alternative to AirDrop

Awesome Lists containing this project

README 

        
# LocalSend



[![CI status][ci-badge]][ci-workflow]



[ci-badge]: https://github.com/localsend/localsend/actions/workflows/ci.yml/badge.svg

[ci-workflow]: https://github.com/localsend/localsend/actions/workflows/ci.yml



[Homepage][homepage] • [Discord][discord] • [GitHub][github] • [Codeberg][codeberg]



[English](README.md) • [中文](readme_i18n/README_ZH.md) • [日本語](readme_i18n/README_JA.md) • [ภาษาไทย](readme_i18n/README_TH.md) • [Filipino](readme_i18n/README_PH.md) • [Polski](readme_i18n/README_PL.md) • [Español](readme_i18n/README_ES.md) • [Tiếng Việt](readme_i18n/README_VI.md) • [Portugês Brasil](readme_i18n/README_PT_BR.md) • [Italiano](readme_i18n/README_IT.md) • [Indonesia](readme_i18n/README_ID.md) • [ភាសាខ្មែរ](readme_i18n/README_KM.md)



[homepage]: https://localsend.org

[discord]: https://discord.gg/GSRWmQNP87

[github]: https://github.com/localsend/localsend

[codeberg]: https://codeberg.org/localsend/localsend



LocalSend is a free, open-source app that allows you to securely share files and messages with nearby devices over your local network without needing an internet connection.



- [About](#about)

- [Screenshots](#screenshots)

- [Download](#download)

- [How It Works](#how-it-works)

- [Getting Started](#getting-started)

- [Contributing](#contributing)

  - [Translation](#translation)

  - [Bug Fixes and Improvements](#bug-fixes-and-improvements)

- [Building](#building)

  - [Android](#android)

  - [iOS](#ios)

  - [macOS](#macos)

  - [Windows](#windows)

  - [Linux](#linux)



## About



LocalSend is a cross-platform app that enables secure communication between devices using a REST API and HTTPS encryption. Unlike other messaging apps that rely on external servers, LocalSend doesn't require an internet connection or third-party servers, making it a fast and reliable solution for local communication.



## Screenshots



iPhone screenshot PC screenshot



## Download



It is recommended to download the app either from an app store or from a package manager because the app does not have an auto-update.



| Windows                 | macOS                   | Linux              | Android        | iOS           | Fire OS    |

|-------------------------|-------------------------|--------------------|----------------|---------------|------------|

| [Winget][]              | [App Store][]           | [Flathub][]        | [Play Store][] | [App Store][] | [Amazon][] |

| [Scoop][]               | [Homebrew][]            | [Nixpkgs][]        | [F-Droid][]    |               |            |

| [Chocolatey][]          | [DMG Installer][latest] | [Snap][]           | [APK][latest]  |               |            |

| [EXE Installer][latest] |                         | [AUR][]            |                |               |            |

| [Portable ZIP][latest]  |                         | [TAR][latest]      |                |               |            |

|                         |                         | [DEB][latest]      |                |               |            |

|                         |                         | [AppImage][latest] |                |               |            |



Read more about [distribution channels][].



[windows store]: https://www.microsoft.com/store/apps/9NCB4Z0TZ6RR

[app store]: https://apps.apple.com/us/app/localsend/id1661733229

[play store]: https://play.google.com/store/apps/details?id=org.localsend.localsend_app

[f-droid]: https://f-droid.org/packages/org.localsend.localsend_app

[amazon]: https://www.amazon.com/dp/B0BW6MP732

[winget]: https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/LocalSend/LocalSend

[scoop]: https://scoop.sh/#/apps?s=0&d=1&o=true&q=localsend&id=fb88113be361ca32c0dcac423cb4afdeda0b0c66

[chocolatey]: https://community.chocolatey.org/packages/localsend

[homebrew]: https://formulae.brew.sh/cask/localsend

[flathub]: https://flathub.org/apps/details/org.localsend.localsend_app

[nixpkgs]: https://search.nixos.org/packages?show=localsend

[snap]: https://snapcraft.io/localsend

[aur]: https://aur.archlinux.org/packages/localsend-bin

[latest]: https://github.com/localsend/localsend/releases/latest

[distribution channels]: https://github.com/localsend/localsend/blob/main/CONTRIBUTING.md#distribution



## Setup



In most cases, LocalSend should work out of the box. However, if you are having trouble sending or receiving files, you may need to configure your firewall to allow LocalSend to communicate over your local network.



| Traffic Type | Protocol | Port  | Action |

|--------------|----------|-------|--------|

| Incoming     | TCP, UDP | 53317 | Allow  |

| Outgoing     | TCP, UDP | Any   | Allow  |



Also make sure to disable AP isolation on your router. It should be usually disabled by default but some routers may have it enabled (especially guest networks).



**Portable Mode**



(Introduced in v1.13.0)



Create a file named `settings.json` located in the same directory as the executable.

This file can be empty.

The app will use this file to store settings instead of the default location.



**Start hidden**



(Updated in v1.15.0)



To start the app hidden (only in tray), use the `--hidden` flag (example: `localsend_app.exe --hidden`).



On v1.14.0 and earlier, the app starts hidden if `autostart` flag is set, and the hidden setting is enabled.



## How It Works



LocalSend uses a secure communication protocol that allows devices to communicate with each other using a REST API. All data is sent securely over HTTPS, and the TLS/SSL certificate is generated on the fly on each device, ensuring maximum security.



For more information on the LocalSend Protocol, see the [documentation](https://github.com/localsend/protocol).



## Getting Started



To compile LocalSend from the source code, follow these steps:



1. Install Flutter [directly](https://flutter.dev) or using [fvm](https://fvm.app) (see [version required](.fvmrc))

2. Clone the `LocalSend` repository

3. Run `cd app` to enter the app directory

4. Run `flutter pub get` to download dependencies

5. Run `flutter run` to start the app



> [!NOTE]

> LocalSend currently requires an older Flutter version (specified in [.fvmrc](.fvmrc))

> and thus build issues may be caused by a mismatch between the required and the (system-wide) installed Flutter version.  

> To make development more consistent, LocalSend uses [fvm](https://fvm.app) to manage the project Flutter version.

> After installing `fvm`, run `fvm flutter` instead of `flutter`.



## Contributing



We welcome contributions from anyone interested in helping improve LocalSend. If you'd like to contribute, there are a few ways to get involved:



### Translation



You can help translate this app to other languages!



1. Fork this repository

2. Choose one

   - Add missing translations in existing languages: Only update `_missing_translations_.json` in [app/assets/i18n][i18n]

   - Fix existing translations: Update `strings_.i18n.json` in [app/assets/i18n][i18n]

   - Add new languages: Create a new file; see also: [locale codes][].

3. Optional: Re-run this app

   1. Run `cd app` to enter the app directory.

   2. Make sure you have [run](#getting-started) this app once.

   3. Update translations via `flutter pub run slang`

   4. Run the app via `flutter run`

   5. Open a pull request



[i18n]: https://github.com/localsend/localsend/tree/main/app/assets/i18n

[locale codes]: https://saimana.com/list-of-country-locale-code/



**_Take note:_ Fields decorated with `@` are not meant to be translated; they are not used in the app in any way, being merely informative text about the file or to give context to the translator.**



### Bug Fixes and Improvements



- **Bug Fixes:** If you find a bug, please create a pull request with a clear description of the issue and how to fix it.

- **Improvements:** Have an idea for how to improve LocalSend? Please create an issue first to discuss why the improvement is needed.



For more information, see the [contributing guide](https://github.com/localsend/localsend/blob/main/CONTRIBUTING.md).



## Building



These commands are intended for maintainers only.



### Android



Traditional APK



```bash

flutter build apk

```



AppBundle for Google Play



```bash

flutter build appbundle

```



### iOS



```bash

flutter build ipa

```



### macOS



```bash

flutter build macos

```



### Windows



**Traditional**



```bash

flutter build windows

```



**Local MSIX App**



```bash

flutter pub run msix:create

```



**Store ready**



```bash

flutter pub run msix:create --store

```



### Linux



**Traditional**



```bash

flutter build linux

```



**AppImage**



```bash

appimage-builder --recipe AppImageBuilder.yml

```



**Snap**



Instructions in [localsend/snap/README.md](https://github.com/localsend/snap/blob/main/README.md)



## Contributors





  Localsend Contributors