Skip to content
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.{kt,kts,java}]
indent_style = space
indent_size = 4
max_line_length = 120

[*.xml]
indent_style = space
indent_size = 4

[*.md]
trim_trailing_whitespace = false

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[Feature] "
labels: enhancement
assignees: ''
---

## Summary
Describe the problem this feature solves and the value.

## Proposed solution
What should be added or changed? UI/UX, API shape, etc.

## Alternatives considered
List any alternative solutions or workarounds.

## Additional context
Screenshots, references, or links.

8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
open-pull-requests-limit: 5

50 changes: 50 additions & 0 deletions .github/workflows/android-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Android CI

on:
push:
branches: [ "master", "main" ]
pull_request:
branches: [ "*" ]

jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 60
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up JDK 17
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '17'

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v3

- name: Set up Android SDK
uses: android-actions/setup-android@v3

- name: Install SDK packages
shell: bash
run: |
sdkmanager --install \
"platforms;android-34" \
"build-tools;34.0.0" \
"platform-tools"
yes | sdkmanager --licenses

- name: Gradle version
run: ./gradlew --version

- name: Lint and unit tests
run: ./gradlew :veridui:lint :veridui:test --no-daemon --stacktrace

- name: Build library and sample
run: ./gradlew :veridui:assembleRelease :sample:assembleDebug --no-daemon --stacktrace

- name: Translation checks
run: |
python3 test_translation.py veridui/src/main/assets/fr.xml

18 changes: 18 additions & 0 deletions .github/workflows/dependency-review.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Dependency Review

on:
pull_request:
branches: [ "master", "main" ]

permissions:
contents: read

jobs:
dependency-review:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Dependency Review
uses: actions/dependency-review-action@v4

13 changes: 13 additions & 0 deletions .github/workflows/gradle-wrapper-validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Validate Gradle Wrapper

on:
pull_request:
branches: [ "*" ]

jobs:
validation:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gradle/wrapper-validation-action@v1

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
![Maven Central](https://img.shields.io/maven-central/v/com.appliedrec.verid/ui2)
![Android CI](https://github.com/AppliedRecognition/Ver-ID-UI-Android/actions/workflows/android-ci.yml/badge.svg)

# Ver-ID UI for Android

Expand Down
8 changes: 4 additions & 4 deletions Translating-Ver-ID-UI.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

Ver-ID UI allows you to supply a language translation when starting a Ver-ID session.

The Ver-ID-UI project provides [Python 2.7](https://www.python.org/download/releases/2.7/) scripts to generate an empty translation XML and to verify that a given file is not missing any translations.
The Ver-ID-UI project provides Python 3 scripts to generate an empty translation XML and to verify that a given file is not missing any translations.

## Generating a translation XML

~~~shell
python translation_xml.py
python3 translation_xml.py
~~~
The command will collect all strings used in the source code and output a string like this:

Expand Down Expand Up @@ -76,14 +76,14 @@ Enter the translation of the string inside the `<original>` tag in the `<transla
To save the generated XML as **es.xml**:

~~~shell
python translation_xml.py > es.xml
python3 translation_xml.py > es.xml
~~~

## Checking that your translation is complete
Once you translate all the strings in the XML run:

~~~shell
python test_translation.py es.xml
python3 test_translation.py es.xml
~~~
If all strings are translated the command will output:

Expand Down
15 changes: 15 additions & 0 deletions sample/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Sample App

- Module: `:sample`
- Builds a demo app using the Ver-ID UI library (`:veridui`).

Build and run

- From IDE: Open the project in Android Studio and run the `sample` configuration on a device.
- CLI: `./gradlew :sample:assembleDebug`

Notes

- The sample uses Compose and AndroidX; ensure you’re on Android Studio Giraffe or newer.
- Some features may require a device with a camera for full functionality.