Skip to content

avniproject/avni-client

Repository files navigation

Avni Client

React Native Android app for the Avni field data collection platform.

License

Prerequisites

  • A Linux or macOS shell — the build is Make + bash. On Windows, use WSL2: follow the step-by-step guide in docs/dev-setup-windows-wsl2.md.
  • Node 20 via nvm (version pinned in .nvmrc)
  • Java 17
  • Android SDK: platform 35, build-tools 35.0.0, NDK 27.1.12297006
  • An Android device or emulator visible to adb
  • Access to an Avni server with an implementation deployed (its URL goes in dev.json below)

Quickstart

git clone https://github.com/avniproject/avni-client.git
cd avni-client

nvm install     # Node version from .nvmrc
make deps       # npm install + patches + prebuild
make test       # optional: verify unit tests pass

cp packages/openchs-android/config/env/dev.json.template packages/openchs-android/config/env/dev.json
# edit dev.json and set SERVER_URL to your Avni server

Then in two terminals:

make run_packager   # terminal 1 — Metro bundler
make run-app        # terminal 2 — build, install & launch on the connected device

Sign in and press the sync button in the app to pull the forms and master data for your implementation.

Documentation

License

AGPL — see LICENSE.

About

Android app for the fieldworkers.

Topics

Resources

License

Stars

11 stars

Watchers

6 watching

Forks

Packages

 
 
 

Contributors