Skip to content

Cynnexis/zephyr

Repository files navigation

Zéphyr

Zéphyr is a dictionary for LSF.

Goals

  • Personal project to learn how to use Flutter and Dart.
  • Many LSF dictionaries exist, but there are no tools available that use them altogether.
  • Few apps are available for mobile concerning LSF.

Demo

Zéphyr demo

Getting Started

The following instructions will get you a copy of the source code, and help you execute it.

Requirements

This project requires Flutter, Dart SDK version: minimum 2.3.0.

For compatibility, please use Flutter 1.20.1 (commit 2ae3451) with its Dart SDK 2.9.0.

Installation

The first thing to do is to download the project, either by downloading the ZIP file and extract it somewhere in your machine, or by cloning the project with git clone https://github.com/Cynnexis/zephyr.git. The following steps will assume that the current directory is the project root.

  1. flutter create --no-overwrite .
  2. flutter pub get
  3. flutter analyze
  4. flutter test
  5. flutter run

The app should be running now.

Build With

Contributing

Contribution is not permitted yet, because one of the goal of the project is for me to learn how to develop mobile app using Flutter SDK and the Dart language.

Author

License

This project is under the GNU General Public License. Please see the LICENSE.txt file for more detail (it's a really fascinating story written in there!)