Getting started #

This document describes how to quickly set up a localized Flutter application that uses Lyrebird.

Install Flutter #

The first step for any Flutter developer is to install the Flutter SDK on your machine. The official Flutter documentation contains an excellent guide for every operating system.

Once you have set up Flutter, you can continue to the next step.

Lyrebird Quickstart #

Clone the Lyrebird Quickstart repository using Git. It contains a Flutter template project that has Lyrebird pre-installed and code generation set up. See the guide on internationalizing Flutter apps for more information.

git clone https://github.com/lyrebird-app/quickstart.git

Navigate to your newly cloned project folder and run

flutter pub get

to install all necessary dependencies, including Lyrebird. Finally, run

flutter pub run lyrebird ./lib/l10n

to start modifying the .ARB files at ./lib/l10n in your app with Lyrebird. At any point, you can use

flutter gen-l10n

to generate source code (i.e. a Flutter localization delegate for your project) from your .ARB files.

Adding Lyrebird to an existing project #

See the next page for a guide on how to install Lyrebird into an existing Flutter or Dart project using .ARB localization files.