Skip to content

STRockefeller/langdida_ui

Repository files navigation

langdida-ui

logo

langdida-ui is a front-end project designed to be used with langdida-server. langdida is a "personal use" language learning tool that I created based on my reference to lingQ. (lingQ is a great language learning platform, but some of its designs did not completely meet my needs, so I decided to create my own language learning tool.)

The UI is designed using flutter and is expected to support the following platforms:

  1. Web page
  2. Android app
  3. Windows app

The UI is expected to include three main pages:

  1. Article reading
  2. Vocabulary review
  3. Learning progress.

Supported development targets

  • Web: supported and validated with a release build.
  • Windows: source scaffold is present, but local release validation is pending installation of the Visual Studio Desktop development with C++ workload.
  • Android: source scaffold is present, but migration and release validation are pending installation of Android Studio, SDK tools, and a test device/emulator.

Tagged releases currently publish only the validated Web artifact. Windows and Android release jobs will be restored after their local toolchains and refreshed platform scaffolds pass release builds.

Installation

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

  • Flutter 3.44.6 stable (Dart 3.12.2). The expected version is recorded in .flutter-version; use the same version locally and in CI.
  • Android Studio (optional, if you want to run the app on Android)
  • Xcode (optional, if you want to run the app on iOS)

Running the app

  1. Clone the repo
  2. Confirm flutter --version reports Flutter 3.44.6
  3. Run flutter pub get to install the dependencies
  4. Run flutter run -d chrome to start the currently supported development target

The consumed backend endpoints and test fixtures are documented in docs/api-contract.md. Release acceptance status is tracked in docs/release-checklist.md.

Contribution

If you want to contribute to this project, please follow the steps below:

  1. Fork the repo
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -m 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Release History

work in progress

Meta

Distributed under the MIT license. See LICENSE for more information.

Screenshots

phone

win

chrome

About

"langdida-ui is a front-end project built with Flutter, designed for a personal language learning tool that supports web, Android, and Windows platforms with three main pages: article reading, vocabulary review, and learning progress."

Resources

License

Stars

1 star

Watchers

1 watching

Forks

Packages

 
 
 

Contributors