doc: add notes from overall discussions
This commit is contained in:
31
README.md
31
README.md
@@ -9,6 +9,28 @@
|
|||||||
|
|
||||||
The Daily Notification Plugin is a comprehensive Capacitor plugin that provides enterprise-grade daily notification functionality across Android, iOS, and Electron platforms. It features dual scheduling, callback support, TTL-at-fire logic, and comprehensive observability.
|
The Daily Notification Plugin is a comprehensive Capacitor plugin that provides enterprise-grade daily notification functionality across Android, iOS, and Electron platforms. It features dual scheduling, callback support, TTL-at-fire logic, and comprehensive observability.
|
||||||
|
|
||||||
|
### **Main Artifacts & Concepts**
|
||||||
|
|
||||||
|
This is meant to be included within another project.
|
||||||
|
|
||||||
|
In addition, it does contain some standalone tests in the `test-apps` directory:
|
||||||
|
- android
|
||||||
|
- in `android-test-app` is an app with buttons to trigger actions
|
||||||
|
- Building capacitor app builds the plugin: `npm install` with a new plugin to get it into `node_modules`, and then building the capacitor app builds from those `node_modules` artifacts.
|
||||||
|
- ios: similar functionality in `ios-test-app`
|
||||||
|
- `daily-notification-test` includes Vue
|
||||||
|
|
||||||
|
Other points:
|
||||||
|
- Alarms persist when backgrounded & when closed
|
||||||
|
- Alarms do not persist when force-stopped - a restart is needed to start the timer
|
||||||
|
- High-level AI docs are in [AI_INTEGRATION_GUIDE.md](./AI_INTEGRATION_GUIDE.md)
|
||||||
|
|
||||||
|
### **Quick Start**
|
||||||
|
|
||||||
|
For the standalone test apps, see [test-apps](./test-apps/BUILD_PROCESS.md).
|
||||||
|
|
||||||
|
For inclusion in another project, see "Installation" below.
|
||||||
|
|
||||||
### 🎯 **Native-First Architecture**
|
### 🎯 **Native-First Architecture**
|
||||||
|
|
||||||
The plugin has been optimized for **native-first deployment** with the following key improvements:
|
The plugin has been optimized for **native-first deployment** with the following key improvements:
|
||||||
@@ -27,6 +49,15 @@ The plugin has been optimized for **native-first deployment** with the following
|
|||||||
|
|
||||||
## Implementation Status
|
## Implementation Status
|
||||||
|
|
||||||
|
### **Overview**
|
||||||
|
|
||||||
|
Dec 17
|
||||||
|
- test-apps
|
||||||
|
- android has been seen to work
|
||||||
|
- ios is being developed (Jose)
|
||||||
|
- after ios, will work on daily-notification-test (that includes Vue)
|
||||||
|
- need to test with real data in the API
|
||||||
|
|
||||||
### ✅ **Phase 2 Complete - Production Ready**
|
### ✅ **Phase 2 Complete - Production Ready**
|
||||||
|
|
||||||
| Component | Status | Implementation |
|
| Component | Status | Implementation |
|
||||||
|
|||||||
@@ -4,6 +4,8 @@
|
|||||||
|
|
||||||
Both test apps are configured to **automatically build the plugin** as part of their build process. The plugin is included as a Gradle project dependency, so Gradle handles building it automatically.
|
Both test apps are configured to **automatically build the plugin** as part of their build process. The plugin is included as a Gradle project dependency, so Gradle handles building it automatically.
|
||||||
|
|
||||||
|
Note that Test App 1 `android-test-app` is used most frequently.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Test App 1: `android-test-app` (Standalone Android)
|
## Test App 1: `android-test-app` (Standalone Android)
|
||||||
@@ -59,7 +61,7 @@ avdmanager list avd
|
|||||||
# Run one
|
# Run one
|
||||||
emulator -avd AVD_NAME
|
emulator -avd AVD_NAME
|
||||||
|
|
||||||
# Check that one is running
|
# Simply see that one is running
|
||||||
adb devices
|
adb devices
|
||||||
|
|
||||||
# Now install on the emulator
|
# Now install on the emulator
|
||||||
|
|||||||
Reference in New Issue
Block a user