mirror of
https://github.com/localsend/localsend.git
synced 2026-06-23 04:10:07 +00:00
Tien Do Nam
194 lines
7.0 KiB
Markdown
194 lines
7.0 KiB
Markdown
# 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]
|
|
|
|
[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
|
|
|
|
<img src="https://localsend.org/img/screenshot-iphone.webp" alt="iPhone screenshot" height="300"/> <img src="https://localsend.org/img/screenshot-pc.webp" alt="PC screenshot" height="300"/>
|
|
|
|
## Download
|
|
|
|
It is recommended to download the app either from an app store or from a package manager because the app does not have auto-update.
|
|
|
|
| Windows | macOS | Linux | Android | iOS | Fire OS |
|
|
|--------------------------|-------------------------|--------------------|----------------|---------------|------------|
|
|
| [Winget][] | [App Store][] | [Flathub][] | [Play Store][] | [App Store][] | [Amazon][] |
|
|
| [Scoop][] | [Homebrew][] | [AUR][] | [F-Droid][] | | |
|
|
| [Chocolatey][] | [DMG Installer][latest] | [NixOS][] | [APK][latest] | | |
|
|
| [MSIX Installer][latest] | | [TAR][latest] | | | |
|
|
| [Portable ZIP][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://github.com/localsend/homebrew-localsend
|
|
[flathub]: https://flathub.org/apps/details/org.localsend.localsend_app
|
|
[aur]: https://aur.archlinux.org/packages/localsend-bin
|
|
[nixos]: https://search.nixos.org/packages?show=localsend
|
|
[latest]: https://github.com/localsend/localsend/releases/latest
|
|
[distribution channels]: https://github.com/localsend/localsend/blob/main/CONTRIBUTING.md#distribution
|
|
|
|
## 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 start LocalSend from source code, follow these steps:
|
|
|
|
1. Install [Flutter](https://flutter.dev)
|
|
2. Clone the LocalSend repository
|
|
3. Run `flutter pub get` to download dependencies
|
|
4. Run `dart run build_runner build -d` to generate code
|
|
5. Run `flutter run` to start the app
|
|
|
|
It may be the case that it doesn't work because of a mismatch between the required Flutter version and the installed Flutter version.
|
|
|
|
LocalSend uses [fvm](https://fvm.app) to manage the project Flutter version (specified in [.fvm/fvm_config.json](.fvm/fvm_config.json)). After you installed it, run `fvm flutter` instead of `flutter`.
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions from anyone who is interested in helping improve LocalSend. If you'd like to contribute, there are a few ways to get involved:
|
|
|
|
### Translation
|
|
|
|
You can help translating this app to other languages!
|
|
|
|
1. Fork this repository
|
|
2. Choose one
|
|
- Add missing translations in existing languages: Only update `_missing_translations_<locale>.json` in [assets/i18n][i18n]
|
|
- Fix existing translations: Update `strings_<locale>.i18n.json` in [assets/i18n][i18n]
|
|
- Add new languages: Create a new file, see also: [locale codes][].
|
|
3. Optional: Re-run this app
|
|
1. Make sure you have [run](#getting-started) this app once.
|
|
2. Update translations via `flutter pub run slang`
|
|
3. Run app via `flutter run`
|
|
4. 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, so we can 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**
|
|
|
|
Feel free to open a pull request. There is a `snap` branch to play with.
|
|
|
|
## Contributors
|
|
|
|
<a href="https://github.com/localsend/localsend/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=localsend/localsend" alt="Localsend Contributors"/>
|
|
</a>
|