Git Product home page Git Product logo

flt's Introduction

flt

flt is a Flutter Terminal Embedder, implementing the Flutter Engine's Custom Embedder API.

This embedder draws to the current terminal window using ANSI Escape Codes to create a Text-based user interface.

Why?

Mainly for fun to learn Rust and more about the Flutter Engine. It can also be a quick playground for Flutter without platform-specific or GUI specific dependencies; only a terminal is needed and it can even be used over SSH.

Supported Platforms / Terminals

This was mainly developed on WSL Linux using the Windows Terminal. It also works on Linux and iTerm2 on macOS. YMMV with other terminal emulators, though it might just work as interfacing with the terminal is done through a cross-platform library.

Not working yet:

  • Windows
  • Terminal.app on macOS

Checkout

This project uses submodules, so pass the --recurse-submodules flag.

git clone --recurse-submodules [email protected]:jiahaog/flt.git

Usage

Install Rust first, then at the root of the monorepo, the following command will build the Sample Flutter App, and run it with the terminal embedder.

cargo run

Other Flutter Projects

cargo run -- <path to the root of your flutter project>

More cli help

# See help for `flt-cli`.
cargo run -- --help

# See help for `flt`.
cargo run -- --args=--help

Project Structure

  • flt - The terminal embedder.
  • flt-cli - A small CLI utility to make local development easier. By default, the cargo run command at the root of the repository will run this.
  • flutter-sys - Safe Rust bindings to the Flutter Embedder API.
  • sample_app - A sample Flutter Project used for local development.
  • third_party/flutter - A submodule checkout of the Flutter Framework.

Missing Pieces

  • Windows support
  • Fix Terminal.app support on macOS
  • Keyboard support
  • Slow performance
  • Improve semantic label positions

References

flt's People

Contributors

jiahaog avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.