# localsend

**Repository Path**: javalover123/localsend

## Basic Information

- **Project Name**: localsend
- **Description**: An open source cross-platform alternative to AirDrop
- **Primary Language**: Dart
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://github.com/localsend/localsend
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 1
- **Created**: 2023-02-08
- **Last Updated**: 2023-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LocalSend

![ci](https://github.com/localsend/localsend/actions/workflows/ci.yml/badge.svg)

Links: [Homepage](https://localsend.org)
| [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)
| [App Store](https://apps.apple.com/us/app/localsend/id1661733229)
| [Windows Store](https://www.microsoft.com/store/apps/9NCB4Z0TZ6RR)

## About

Share files to nearby devices. Free, open source, cross-platform.

This app allows you to send files and messages over the local LAN network.

No internet required, no external servers needed.

## Screenshots

<div style="display:flex">
<img src="https://localsend.org/img/screenshot-iphone.png" alt="screenshot1" height="300"/>
<img src="https://localsend.org/img/screenshot-pc.png" alt="screenshot2" height="300"/>
</div>

## Protocol

Devices communicate with each other using a REST API. 

Everything is sent securely over HTTPS. The TLS/SSL certificate is generated on the fly on each device.

For more information: [LocalSend Protocol v1](https://github.com/localsend/protocol)

## Run

After you have installed [Flutter](https://flutter.dev), then you can start this app by typing the following commands: 

```shell
flutter pub get
flutter pub run build_runner build -d
flutter run
```

## Contributing

### Translation

You can help translating this app to other languages!

1. Preparation (Choose one)
   - Add missing translations in existing languages: [assets/i18n/_missing_translations.json](https://github.com/localsend/localsend/blob/main/assets/i18n/_missing_translations.json)
   - Fix existing translations in [assets/i18n](https://github.com/localsend/localsend/tree/main/assets/i18n)
   - Add new languages: [locale codes](https://saimana.com/list-of-country-locale-code/).
2. Fork this repository
3. Create or update the translation file in [assets/i18n](https://github.com/localsend/localsend/tree/main/assets/i18n) (format: `strings_XXX.i18n.json`)
4. Optional: Re-run this app
   1. Make sure you have [run](#run) this app once.
   2. Update translations via `flutter pub run slang`
   3. Run app via `flutter run`
5. Open a pull request

**Important:** Do not translate keys starting with `@`. These are comments and should stay in English!

For convenience, you can use this link: https://github.com/localsend/localsend/new/main/assets/i18n

### Bug fixes

Any bug fix is welcome! Please describe how and why your fix is needed in the PR.

### Improvements

This app is very simple and should stay that way.

Please create an issue first so we can discuss why this improvement is needed.

## Build

These commands are mostly for the maintainers.

Please ensure that `flutter pub run build_runner build` has been run. Otherwise, files will be missing.

### Android

Traditional APK

```shell
flutter build apk
```

AppBundle for Google Play

```shell
flutter build appbundle
```

### iOS

```shell
flutter build ipa
```

### MacOS

```shell
flutter build macos
```

### Windows

**Traditional**

```shell
flutter build windows
```

**Local MSIX App**

```shell
flutter pub run msix:create
```

**Store ready**

```shell
flutter pub run msix:create --store
```

### Linux

**Traditional**

```shell
flutter build linux
```

**AppImage**

```shell
appimage-builder --recipe AppImageBuilder.yml
```

**Snap**

Feel free to open a pull request. There is a  `snap` branch to play with.