Initial commit
This commit is contained in:
40
README.md
Normal file
40
README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Keeply for Android
|
||||
|
||||
A native Android version of the Keeply pantry manager, built with Kotlin and Jetpack Compose. It talks directly to the same ASP.NET API as `new-pantry-management-frontend`; it is not a WebView or React Native wrapper.
|
||||
|
||||
## Included
|
||||
|
||||
- JWT sign-in, registration, encrypted token storage, session restore, and automatic token refresh
|
||||
- Pantry summary, search, freshness/location filters, grouped product entries, and item CRUD
|
||||
- Native Google barcode scanner with manual-entry fallback and barcode-first quick add
|
||||
- Location CRUD
|
||||
- Household creation/editing, member invites, and leave-household flow
|
||||
- Role-gated site administrator user management
|
||||
- Profile, email, name, and password settings
|
||||
- Adaptive navigation for phones and tablets
|
||||
|
||||
## Open and run
|
||||
|
||||
Open this folder in Android Studio, allow Gradle sync to finish, and run the `app` configuration on an Android 6.0 (API 23) or newer device/emulator.
|
||||
|
||||
The production API is used by default:
|
||||
|
||||
```text
|
||||
https://api.pantrymanager.kitchen
|
||||
```
|
||||
|
||||
To use a different API, pass a Gradle property. Android emulators reach the host machine at `10.0.2.2`:
|
||||
|
||||
```powershell
|
||||
.\gradlew.bat assembleDebug -PKEEPLY_API_BASE_URL=http://10.0.2.2:5000
|
||||
```
|
||||
|
||||
Debug builds permit cleartext HTTP for local development. Release builds require HTTPS.
|
||||
|
||||
## Validate
|
||||
|
||||
```powershell
|
||||
.\gradlew.bat testDebugUnitTest lintDebug assembleDebug
|
||||
```
|
||||
|
||||
The debug APK is written to `app\build\outputs\apk\debug\app-debug.apk`.
|
||||
Reference in New Issue
Block a user