Initial commit: deardiary project setup
This commit is contained in:
73
android/README.md
Normal file
73
android/README.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Android App
|
||||
|
||||
Native Android app using Kotlin and Jetpack Compose that connects to the same TotalRecall API.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Android Studio Hedgehog or newer
|
||||
- Android SDK 34
|
||||
- Kotlin 1.9+
|
||||
- Java 17
|
||||
|
||||
## Building
|
||||
|
||||
1. Open Android Studio
|
||||
2. File > Open > select the `android` folder
|
||||
3. Wait for Gradle sync to complete
|
||||
4. Build > Build APK
|
||||
|
||||
Or from command line:
|
||||
|
||||
```bash
|
||||
cd android
|
||||
./gradlew assembleDebug
|
||||
```
|
||||
|
||||
The APK will be at: `app/build/outputs/apk/debug/app-debug.apk`
|
||||
|
||||
## Configuration
|
||||
|
||||
By default, the app connects to `http://10.0.2.2:3000/api/v1/` (localhost for Android emulator).
|
||||
|
||||
To change the API URL, edit `app/build.gradle.kts`:
|
||||
|
||||
```kotlin
|
||||
buildConfigField("String", "API_BASE_URL", "\"http://your-server:3000/api/v1/\"")
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- User registration and login
|
||||
- Create text entries
|
||||
- Voice memos
|
||||
- Health check-ins
|
||||
- View history by day
|
||||
- Generate AI journal
|
||||
- Configure AI provider (OpenAI, Anthropic, Ollama, LM Studio)
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
android/
|
||||
├── app/src/main/java/com/totalrecall/
|
||||
│ ├── api/ # API client
|
||||
│ ├── model/ # Data models
|
||||
│ ├── repository/ # Repository pattern
|
||||
│ ├── viewmodel/ # ViewModels
|
||||
│ └── ui/ # Compose UI screens
|
||||
│ ├── auth/
|
||||
│ ├── home/
|
||||
│ ├── history/
|
||||
│ ├── journal/
|
||||
│ └── settings/
|
||||
├── build.gradle.kts
|
||||
└── settings.gradle.kts
|
||||
```
|
||||
|
||||
## Screenshots
|
||||
|
||||
Coming soon...
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user