wordshk_app

(β˜… 64)

An open Cantonese dictionary for iOS and Android built with Flutter

Showing a partial file list β€” download the zip above to see everything.

  • .fvmrc
  • .gitignore
  • .metadata
  • analysis_options.yaml
  • apple-app-site-association
  • assetlinks.json
  • LICENSE
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/AlienKevin/wordshk_app

Downloads the entire project code from GitHub to your computer.

cd wordshk_app

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

3. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
cd android

This project's files live in a subfolder, so move into it first.

bundle install

Installs the Ruby libraries listed in the Gemfile.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
// repository documentation