|
1 | | -<div align="center"> |
2 | | - <img src="assets/github-logo-v3.png" width="140" alt="IronLog logo" style="margin-bottom: 2px;" /> |
| 1 | +# Ironlog |
3 | 2 |
|
4 | | - <h1>Ironlog</h1> |
| 3 | +Ironlog is being rebuilt as a native Kotlin Android app. |
5 | 4 |
|
6 | | - <p><strong>Offline-first Android workout tracker with live next-session targets, muscle analytics, premium themes, and local-first backups.</strong></p> |
| 5 | +The old React Native build information has been removed because it no longer reflects the active product direction. |
7 | 6 |
|
8 | | - <p>Built for lifters who want fast logging in the gym, serious feedback after the session, and full control over their data.</p> |
| 7 | +## Kotlin Version Coming Soon |
9 | 8 |
|
10 | | - <p> |
11 | | - <a href="https://github.com/Yannam-Builds/Ironlog/releases"><img src="https://img.shields.io/badge/releases-Legacy_Alpha-ff6a00" alt="Legacy alpha releases" /></a> |
12 | | - <a href="https://github.com/Yannam-Builds/Ironlog/releases"><img src="https://img.shields.io/github/downloads/Yannam-Builds/Ironlog/total" alt="Downloads" /></a> |
13 | | - <a href="https://github.com/Yannam-Builds/Ironlog/commits"><img src="https://img.shields.io/github/last-commit/Yannam-Builds/Ironlog" alt="Last commit" /></a> |
14 | | - <a href="LICENSE"><img src="https://img.shields.io/badge/license-source--available-orange.svg" alt="Source-available license" /></a> |
15 | | - </p> |
| 9 | +A new Kotlin-first Ironlog release is in progress with: |
16 | 10 |
|
17 | | - <p> |
18 | | - <a href="https://github.com/Yannam-Builds/Ironlog/releases"><img src="https://img.shields.io/badge/Download-Legacy_Alpha_APK-ff6a00?style=for-the-badge" alt="Download legacy alpha APK" /></a> |
19 | | - <a href="https://github.com/Yannam-Builds/Ironlog/releases/latest"><img src="https://img.shields.io/badge/Android-Only-1b1b1b?style=for-the-badge&logo=android&logoColor=3DDC84" alt="Android only" /></a> |
20 | | - </p> |
| 11 | +- native Android architecture |
| 12 | +- ObjectBox-backed offline storage |
| 13 | +- workout logging, plans, stats, recovery, widgets, and backup/restore flows |
| 14 | +- a cleaner long-term foundation for performance, reliability, and Android-native features |
21 | 15 |
|
22 | | - <p><sub>Android 7.0+ | local-first WatermelonDB migration in progress | backup and import/export built in</sub></p> |
23 | | -</div> |
| 16 | +The public repository will be refreshed when the Kotlin version is ready. |
24 | 17 |
|
25 | | -## Legacy Release Policy |
| 18 | +## Current Status |
26 | 19 |
|
27 | | -- `v1.0.0`, `v1.1.0-beta`, and `v1.1.0` are now **Legacy Alpha** releases. |
28 | | -- Legacy releases are **unsupported** and receive no fixes. |
29 | | -- Ironlog will be back soon with the best possible feature set: faster logging, stronger restore/import, and a cleaner WatermelonDB-first runtime. |
30 | | - |
31 | | -## Featured Screens |
32 | | - |
33 | | -<table> |
34 | | - <tr> |
35 | | - <td align="center" width="50%"> |
36 | | - <a href="features/screenshots/full/01-home-dashboard-amoled-smart-overview.jpg"> |
37 | | - <img src="features/screenshots/01-home-dashboard-amoled-smart-overview.jpg" alt="IronLog AMOLED home dashboard with smart training targets, weekly summary, and recovery map." width="100%" /> |
38 | | - </a> |
39 | | - <br /> |
40 | | - <strong>AMOLED smart dashboard</strong> |
41 | | - <br /> |
42 | | - Home combines next-session targets, weekly progress, bodyweight context, and recovery at a glance. |
43 | | - </td> |
44 | | - <td align="center" width="50%"> |
45 | | - <a href="features/screenshots/full/02-home-dashboard-light-theme.jpg"> |
46 | | - <img src="features/screenshots/02-home-dashboard-light-theme.jpg" alt="IronLog light theme home dashboard showing the same smart recommendation and weekly recovery layout." width="100%" /> |
47 | | - </a> |
48 | | - <br /> |
49 | | - <strong>Theme parity</strong> |
50 | | - <br /> |
51 | | - The visual system carries across AMOLED and light themes instead of treating alternate themes like second-class modes. |
52 | | - </td> |
53 | | - </tr> |
54 | | - <tr> |
55 | | - <td align="center" width="50%"> |
56 | | - <a href="features/screenshots/full/03-program-insights-adaptive-targets.jpg"> |
57 | | - <img src="features/screenshots/03-program-insights-adaptive-targets.jpg" alt="IronLog program insights screen with adherence, goal mode, and adaptive next targets." width="100%" /> |
58 | | - </a> |
59 | | - <br /> |
60 | | - <strong>Program intelligence</strong> |
61 | | - <br /> |
62 | | - Goal mode, adherence, day status, and adaptive next targets stay tied to real session history. |
63 | | - </td> |
64 | | - <td align="center" width="50%"> |
65 | | - <a href="features/screenshots/full/05-log-history-session-cards.jpg"> |
66 | | - <img src="features/screenshots/05-log-history-session-cards.jpg" alt="IronLog log screen with multiple workout cards and detailed exercise history." width="100%" /> |
67 | | - </a> |
68 | | - <br /> |
69 | | - <strong>Fast logging, readable history</strong> |
70 | | - <br /> |
71 | | - The app stays fast in-session and still gives you dense session history without turning the log into noise. |
72 | | - </td> |
73 | | - </tr> |
74 | | - <tr> |
75 | | - <td align="center" width="50%"> |
76 | | - <a href="features/screenshots/full/07-volume-analytics-radar-overview.jpg"> |
77 | | - <img src="features/screenshots/07-volume-analytics-radar-overview.jpg" alt="IronLog muscle analytics overview with radar chart and weekly totals." width="100%" /> |
78 | | - </a> |
79 | | - <br /> |
80 | | - <strong>Muscle analytics</strong> |
81 | | - <br /> |
82 | | - Effective sets, volume interpretation, workout totals, and radar views turn raw logs into useful context. |
83 | | - </td> |
84 | | - <td align="center" width="50%"> |
85 | | - <a href="features/screenshots/full/09-muscle-recovery-front-map.jpg"> |
86 | | - <img src="features/screenshots/09-muscle-recovery-front-map.jpg" alt="IronLog recovery screen with front muscle map and recovery score." width="100%" /> |
87 | | - </a> |
88 | | - <br /> |
89 | | - <strong>Recovery maps</strong> |
90 | | - <br /> |
91 | | - Front and back heatmaps reflect recent training stimulus instead of decorative anatomy art. |
92 | | - </td> |
93 | | - </tr> |
94 | | - <tr> |
95 | | - <td align="center" width="50%"> |
96 | | - <a href="features/screenshots/full/11-bodyweight-tracker-30d.jpg"> |
97 | | - <img src="features/screenshots/11-bodyweight-tracker-30d.jpg" alt="IronLog bodyweight screen with 30-day chart and history cards." width="100%" /> |
98 | | - </a> |
99 | | - <br /> |
100 | | - <strong>Bodyweight tracking</strong> |
101 | | - <br /> |
102 | | - Weight history, trend cards, and share flow stay integrated with the rest of the training system. |
103 | | - </td> |
104 | | - <td align="center" width="50%"> |
105 | | - <a href="features/screenshots/full/12-backup-center-drive-and-encrypted-backups.jpg"> |
106 | | - <img src="features/screenshots/12-backup-center-drive-and-encrypted-backups.jpg" alt="IronLog backup center with encrypted snapshots, Google Drive options, and restore tools." width="100%" /> |
107 | | - </a> |
108 | | - <br /> |
109 | | - <strong>Backup and ownership</strong> |
110 | | - <br /> |
111 | | - Encrypted local snapshots, import/export flows, and Drive backup targets are built into the product, not bolted on later. |
112 | | - </td> |
113 | | - </tr> |
114 | | -</table> |
115 | | - |
116 | | -See the full 23-shot gallery in [features/README.md](features/README.md), browse compact thumbs in [features/screenshots/](features/screenshots/), or open full-resolution images in [features/screenshots/full/](features/screenshots/full/). |
117 | | - |
118 | | -## Current Android Feature Set |
119 | | - |
120 | | -- Fast workout logging with set history, edit/delete, add exercise during session, rest timer, warm-up generation, and premium haptics. |
121 | | -- Plans, built-in program picker, goal modes, Program Insights, adaptive targets, and practical progression rules. |
122 | | -- Muscle analytics, volume radar, imbalance insights, recovery score, front/back recovery maps, and session quality summaries. |
123 | | -- Bodyweight tracking, progress photos, calendar history, stats, PR surfacing, weekly summaries, and share cards. |
124 | | -- 1,731-exercise v2 library with movement pattern, difficulty, bodyweight, and equipment metadata; fuzzy MiniSearch with movement, difficulty, and BW-only filters. |
125 | | -- AMOLED, light, and Monet-inspired theme variants with the same dense information layout across modes. |
126 | | -- Local-first SQLite storage, encrypted backup center, Drive backup targets, SQLite import/export, and notification policy controls. |
127 | | - |
128 | | -## Themes |
129 | | - |
130 | | -Ironlog is not locked to one visual style. The current Android build ships with an AMOLED-first look, a full light theme, and Monet-inspired variants while keeping the same layout, contrast hierarchy, and training density across all of them. |
131 | | - |
132 | | -## What Comes Next |
133 | | - |
134 | | -- Phase 1: portability and migration with OpenWeight export/import, Strong and Hevy import review, duplicate detection, and alias resolution. |
135 | | -- Phase 2: coach-grade program building with mesocycle tools, progression models, `%1RM` prescriptions, and optional `RPE` / `RIR` support. |
136 | | -- Phase 3: explainability upgrades so progression, plateau, recovery, and imbalance outputs state why they fired and how confident they are. |
137 | | -- Phase 4: continuity and hardening for larger histories, export parity closure, deeper QA, and optional encrypted multi-device continuity where it genuinely helps. |
138 | | - |
139 | | -## Data Ownership |
140 | | - |
141 | | -- Internal source of truth: local SQLite on Android. |
142 | | -- Backup today: encrypted local snapshots, SQLite export/import, JSON/CSV flows, and optional Google Drive backup targets. |
143 | | -- Drive supports hidden `AppData` mode and visible folder mode. It is a backup target, not a fake always-on sync layer. |
144 | | -- Android OS auto-backup interaction and QA contract: [docs/android-auto-backup.md](docs/android-auto-backup.md). |
145 | | - |
146 | | -## Download |
147 | | - |
148 | | -Public APKs on [GitHub Releases](https://github.com/Yannam-Builds/Ironlog/releases) are Legacy Alpha and unsupported. |
149 | | - |
150 | | -Ironlog will return soon with the best possible feature set on the WatermelonDB line. |
151 | | - |
152 | | -## Build From Source |
153 | | - |
154 | | -```bash |
155 | | -npm install |
156 | | -npx react-native run-android |
157 | | -``` |
158 | | - |
159 | | -### Signed Release APK (Android) |
160 | | - |
161 | | -For update-safe production installs, build with your own release keystore (do not use debug signing): |
162 | | - |
163 | | -```bash |
164 | | -cd android |
165 | | -./gradlew assembleRelease |
166 | | -``` |
167 | | - |
168 | | -Output: |
169 | | - |
170 | | -- `android/app/build/outputs/apk/release/app-release.apk` |
171 | | - |
172 | | -Install/update on device: |
173 | | - |
174 | | -```bash |
175 | | -adb install -r android/app/build/outputs/apk/release/app-release.apk |
176 | | -``` |
177 | | - |
178 | | -## Suggestions and Community Chat |
179 | | - |
180 | | -- Feature requests and bug reports: [Issues](https://github.com/Yannam-Builds/Ironlog/issues/new/choose) |
181 | | -- Optional discussion threads: [GitHub Discussions](https://github.com/Yannam-Builds/Ironlog/discussions) |
182 | | -- Support contact: `ironlogsupport@gmail.com` |
183 | | - |
184 | | -## Contributing |
185 | | - |
186 | | -See [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). |
187 | | - |
188 | | -## Business Docs |
189 | | - |
190 | | -Founder and commercial planning docs live in `docs/business/`. |
191 | | - |
192 | | -Key files: |
193 | | - |
194 | | -- [acquisition-memo.md](docs/business/acquisition-memo.md) |
195 | | -- [buyer-outreach-templates.md](docs/business/buyer-outreach-templates.md) |
196 | | -- [valuation-sheet.md](docs/business/valuation-sheet.md) |
197 | | -- [sale-channels.md](docs/business/sale-channels.md) |
198 | | -- [play-store-launch-and-monetization.md](docs/business/play-store-launch-and-monetization.md) |
199 | | -- [android-hardening-and-billing-plan.md](docs/business/android-hardening-and-billing-plan.md) |
200 | | -- [kotlin-vs-ship-plan.md](docs/business/kotlin-vs-ship-plan.md) |
201 | | - |
202 | | -## License |
203 | | - |
204 | | -Ironlog is source-available, not OSI open source. |
205 | | - |
206 | | -It is released under the [IronLog Personal Use License](LICENSE) for personal and non-commercial use. |
207 | | - |
208 | | -Current repository legal docs: |
209 | | - |
210 | | -- [LICENSE](LICENSE) - the controlling license |
211 | | -- [TERMS.md](TERMS.md) - repository use summary and restrictions |
212 | | -- [COMMERCIAL-LICENSING.md](COMMERCIAL-LICENSING.md) - commercial licensing and acquisition path |
213 | | -- [TRADEMARKS.md](TRADEMARKS.md) - brand and identity restrictions |
214 | | -- [PRIVACY-POLICY.md](PRIVACY-POLICY.md) - current privacy baseline for app and backup flows |
215 | | -- [TERMS-OF-USE.md](TERMS-OF-USE.md) - app usage terms for launch preparation |
216 | | - |
217 | | -Commercial use, resale, app-store publication, white-label use, and hosted business use require separate permission. |
218 | | - |
219 | | -## Repository Hygiene |
220 | | - |
221 | | -- Active runtime work stays in: `src/`, `android/`, `assets/`, `docs/`, `scripts/`. |
222 | | -- Historical artifacts (old screenshots, logs, temp dumps, one-off reports/prompts) are archived in `archive/`. |
223 | | -- Cross-agent handoff log is in `docs/changes/`. |
224 | | -- Every meaningful session should append a short entry to the current date file. |
| 20 | +The previous public build is legacy and unsupported. Wait for the Kotlin release before using this repository as a source reference. |
0 commit comments