diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 599bd95..b136d18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,8 @@ buildeléséhez hogy a brotli a PATH-ben legyen ## Windows - Töltsd le a `brotli-x64-windows-static.zip`-et a [google/brotli github repoból](https://github.com/google/brotli/releases/latest) -- Csomagold ki valahol (pl. C:\Users\\dev\brotli) -- Add hozzá a mappát ahova kicsomagoltad (C:\Users\\dev\brotli) a PATH-hez +- Csomagold ki valahol (pl. C:\Users\\\dev\brotli) +- Add hozzá a mappát ahova kicsomagoltad (C:\Users\\\dev\brotli) a PATH-hez - Ne felejtsd el újraindítani az IDE-det illetve parancssorodat utánna hogy frissúljön a PATH ## Linux/MacOS @@ -53,5 +53,5 @@ $ ./dev/tools/build_release.sh ## Release apk buildelése ```shell -$ ./tools/linux/build_apk.sh +$ ./tools/linux/build_apk.sh main ``` \ No newline at end of file diff --git a/CONTRIBUTING_en.md b/CONTRIBUTING_en.md new file mode 100644 index 0000000..c3bf9d6 --- /dev/null +++ b/CONTRIBUTING_en.md @@ -0,0 +1,57 @@ +# Installing flutter + +The documentation for installing flutter can be found [here](https://docs.flutter.dev/get-started/install). + +# Brotli + +Firka uses brotli to compress libflutter during the build process to make the app smaller, +so building Firka requires you to have brotli in your path + +## Windows +- Download `brotli-x64-windows-static.zip` from [google/brotli](https://github.com/google/brotli/releases/latest) +- Extract it to somewhere like C:\Users\\\dev\brotli +- Add the directory (ex. C:\Users\\\dev\brotli) to your PATH +- Don't forget to restart your IDE or terminal sessions for the PATH variable to update + +## Linux/MacOS +Install it using your distro's package manager + +# Keystore + +[Secrets docs](secrets/README_en.md) + +# Flutter l10n + +Generating flutter l10n files + +```shell +flutter gen-l10n --template-arb-file app_hu.arb +``` + +# Android debug build + +The dev build doesn't require using a custom keystore +```shell +$ cd firka +$ flutter build apk --debug --target-platform android-arm,android-arm64,android-x64 +``` + +# Android release build + +The release build requires using a custom keystore and our custom flutter fork + +## Setting up our flutter engine fork + +```shell +$ git clone https://git.firka.app/firka/flutter +$ cd flutter +$ . dev/tools/envsetup.sh +$ gclient sync -D +$ ./dev/tools/build_release.sh +``` + +## Building the release apk + +```shell +$ ./tools/linux/build_apk.sh main +``` \ No newline at end of file diff --git a/README.md b/README.md index 2d2d95d..3d97fae 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Firka Napló +| HU [Magyar](README.md) | EN [English](README_en.md) | +|-----------------------------------|---------------------------------------| + [![Crowdin](https://badges.crowdin.net/firka/localized.svg)](https://crowdin.com/project/firka) ## A projektről diff --git a/README_en.md b/README_en.md new file mode 100644 index 0000000..3b689b1 --- /dev/null +++ b/README_en.md @@ -0,0 +1,13 @@ +# Firka + +| HU [Magyar](README.md) | EN [English](README_en.md) | +|-----------------------------------|---------------------------------------| + +[![Crowdin](https://badges.crowdin.net/firka/localized.svg)](https://crowdin.com/project/firka) + +## The project + +Firka is an alternative client for [an application to be named]. The app's goal is to be a modern +user friendly app for the [to be named] system. + +[Contribution guide](CONTRIBUTING_en.md) \ No newline at end of file diff --git a/secrets/README_en.md b/secrets/README_en.md new file mode 100644 index 0000000..ada4c92 --- /dev/null +++ b/secrets/README_en.md @@ -0,0 +1,40 @@ +# hogyan hozz létre upload-keystore-t flutterhez? + +ha ezt olvasod, akkor valószínűleg szeretnéd a refilc appot build-elni. ha bármi kérdésed lenne, nyugodtan keress minket discordon, vagy akár emailben is! + +## 1. keystore létrehozása + +először, nyiss egy terminált ebben a mappában és futtasd ezt a parancsot: + +```sh +keytool -genkeypair -v \ + -keystore upload-keystore.jks \ + -keyalg RSA -keysize 2048 -validity 10000 \ + -alias upload +``` + +ezután meg kell adnod néhány adatot: +- egy jelszót a keystore-hoz (ezt jegyezd meg!) +- nevedet, szervezeted nevét (nyugodtan hagyhatod alapértelmezetten) +- egy második jelszót az „upload” aliashoz (ajánlott az előzőt használni) + +ha minden jól megy, egy `upload-keystore.jks` fájl létrejön. + +## 3. keystore.properties létrehozása + +hozz létre egy új fájlt `keystore.properties` néven, és írd bele a következőt: + +```properties +storeFile=upload-keystore.jks +storePassword=password +keyPassword=password +keyAlias=upload +``` + +cseréld ki a `password` részeket, természetesen a választott jelszavadra. + +## 4. secrets mappa kizárása a gitből + +már beleraktuk a .gitignore mappába a kizárását ennek, ezen nem kell aggódnod. + +készen is vagy, sok sikert!