https://github.com/lflxp/flutter-desktop-demo
flutter desktop demo for study
https://github.com/lflxp/flutter-desktop-demo
Last synced: 3 months ago
JSON representation
flutter desktop demo for study
- Host: GitHub
- URL: https://github.com/lflxp/flutter-desktop-demo
- Owner: lflxp
- License: apache-2.0
- Created: 2019-07-11T10:57:43.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-11T10:58:32.000Z (about 7 years ago)
- Last Synced: 2025-01-20T10:48:29.331Z (over 1 year ago)
- Language: Dart
- Size: 1.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Desktop Embedding for Flutter
This project was originally created to develop Windows, macOS, and Linux
embeddings of [Flutter](https://github.com/flutter/flutter). That work has
since [become part of
Flutter](https://github.com/flutter/flutter/wiki/Desktop-shells), and this
project is now just an example of, and test environment for, building
applications using those libraries in their current state. It also
includes some experimental, early stage desktop plugins.
As explained in the link above, desktop libraries are still in early stages.
**The code here is not stable, nor intended for production use.**
## Setting Up
This project is closely tied to changes in the Flutter repository, so
you must be on the latest version of the [Flutter master
channel](https://github.com/flutter/flutter/wiki/Flutter-build-release-channels#how-to-change-channels).
You should always update this repository and Flutter at the same time,
as breaking changes for desktop happen frequently.
### Tools
Run `flutter doctor` and be sure that no issues are reported for the sections
relevant to your platform.
## Running a Project
### Example
Once you have everything set up, just `flutter run` in the `example` directory
to run your first desktop Flutter application!
Note: Only `debug` mode is currently available. Running with `--release` will
succeed, but the result will still be using a `debug` Flutter configuration:
asserts will fire, the observatory will be enabled, etc.
### Running Other Flutter Projects
See [the example README](example/README.md) for information on using the
example as a starting point to run another project.
### IDEs
If you want to use an IDE to run a Flutter project on desktop, you will need to
have the `ENABLE_FLUTTER_DESKTOP` environment variable set to `true` in the IDE:
* VS Code: Add the flag to [dart.env](https://dartcode.org/docs/settings/#dartenv)
in the VS Code `settings.json`:
```
"dart.env": {
"ENABLE_FLUTTER_DESKTOP": true,
}
```
* You can also attach to a desktop Flutter application launched some other way
using the `Debug: Attach to Flutter Process` command and copying in the
Observatory URI that was logged on launch.
* IntelliJ/Android Studio: You will need to set the environment for the
application using the normal process for your OS (e.g., launching it from a
terminal with the environment variable set may work). You will know the
variable is correctly set if the devices menu lists your machine as a device.
## Repository Structure
`testbed` is a more complex example that is primarily intended for people
actively working on Flutter for desktop. See [its README](testbed/README.md)
for details.
The `plugins` directory has early-stage desktop
[plugins](https://flutter.dev/docs/development/packages-and-plugins/developing-packages). See the [README](plugins/README.md) for details.
## Feedback and Discussion
For bug reports and feature requests specific to the example or the plugins,
you can file GitHub issues. Bugs and feature requests related to desktop support
in general should be filed in the
[Flutter issue tracker](https://github.com/flutter/flutter/issues).
For general discussion and questions there's a [project mailing
list](https://groups.google.com/forum/#!forum/flutter-desktop-embedding-dev).
## Caveats
* This is not an officially supported Google product.
* The code and examples here, and the desktop Flutter libraries they use, are
in early stages, and not intended for production use.