From 52fdb8611f56b36bcbd8519ab1b25ca8ad29dfd0 Mon Sep 17 00:00:00 2001 From: xrpbanks <126300068+xrpbanks@users.noreply.github.com> Date: Thu, 10 Sep 2026 15:56:37 +0200 Subject: [PATCH 1/2] Clarify historical prototype and direct readers to current CalorieApp --- README.md | 379 ++--------------------- docs/OFFICIAL_PROJECT_DOCS.md | 71 +---- docs/README.md | 62 +--- docs/REGULATORY_BOUNDARY.md | 12 +- docs/archive/README-before-2026-09-10.md | 367 ++++++++++++++++++++++ 5 files changed, 414 insertions(+), 477 deletions(-) create mode 100644 docs/archive/README-before-2026-09-10.md diff --git a/README.md b/README.md index e0d47d9..a7a4cfd 100644 --- a/README.md +++ b/README.md @@ -1,367 +1,38 @@ -# CalorieApp ๐ŸŽ +# CalorieApp Testnet archive -[![CI](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ci.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ci.yml) -[![CodeQL](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/codeql.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/codeql.yml) -[![UX Tour](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ux_tour.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ux_tour.yml) -[![Version](https://img.shields.io/badge/version-1.1.2-blue.svg)](https://github.com/CalorieToken/CalorieAppTestnet) -[![Python](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/) -[![License](https://img.shields.io/badge/license-Custom%20Dual-orange.svg)](LICENSE) -[![Website](https://img.shields.io/badge/website-calorietoken.net-green.svg)](https://calorietoken.net) -[![XRPL](https://img.shields.io/badge/XRPL-Mainnet%20%26%20Testnet-blue.svg)](https://xrpl.org/) +**Historical prototype ยท test assets only ยท separate from the current CalorieApp** -A mobile-first cryptocurrency wallet and food tracking application for **CalorieToken** on the XRP Ledger, built with KivyMD. +This repository preserves earlier Kivy/KivyMD experiments with XRP Ledger interfaces and food tracking. It explains the project's development history. It is not the current CalorieApp V2 runtime, a maintained Mainnet wallet, a live exchange or a payment service. -> **Rights correction (2026):** ICTHendrikse (KvK 73774693) administers -> rights in original portions it created or lawfully acquired. CalorieToken is -> a registered EU trade mark owned by Pieter Hendrikse. Earlier references to -> Calorie Token VOF (KvK 84216352) are historical and do not by themselves -> prove transfer of every IP right. See `LICENSE`, `COPYRIGHT.md`, and `NOTICE`. +[Current food webapp](https://calorietoken.net/index.php/calorieapp/) ยท [Current source](https://github.com/CalorieToken/CalorieApp) ยท [Whitepaper and roadmap](https://github.com/CalorieToken/Publications) -> **Regulatory boundary:** this is a historical, experimental XRP Ledger -> Testnet prototype, not the current CalorieApp V1 production runtime and not a -> live wallet, exchange, payment service, or investment product. See -> [`docs/REGULATORY_BOUNDARY.md`](docs/REGULATORY_BOUNDARY.md). +## Read this repository in context -> **Latest Update (2025-11-18 โ€“ v1.1.1):** Repository hardening, public-safe documentation index, UX layout consistency, security enhancements. See [CHANGELOG](docs/CHANGELOG.md#111---2025-11-18). Pending merge from branch `chore/repo-hardening`. +| Material | How to interpret it | +| --- | --- | +| Wallet, token, trustline and transaction screens | Historical Testnet experiments; do not use real funds or Mainnet recovery information | +| DEX, NFT, CalorieDB and payment concepts | Earlier exploration, without a current delivery or regulatory claim | +| Test reports and screenshots | Evidence for their stated build and date, not proof of today's deployed website/app | +| Current website Testnet guide | A separate user guide in the WordPress package, not activation of this old wallet runtime | +| Community Voting Hub | Informational; no active voting, proposal submission or reward programme | -## โš–๏ธ Legal & Beta Testnet Disclaimer +Testnet assets have no real monetary or redeemable value, and the network can reset. Historical references to Mainnet-ready behaviour, completed features or future rewards must not be used as current product claims. No third-party security audit, financial permission or current operational readiness is asserted. -This software ("CalorieApp") is a preโ€‘release **beta** operating solely on the XRP Ledger **Testnet**. By accessing, cloning, building, or using any portion of this repository you acknowledge and agree to the following clauses: +## Documentation -1. Experimental Status: All features (wallets, tokens, NFT, DEX, food tracking, UI components) are experimental and subject to modification, suspension, or removal without notice prior to any mainnet launch. -2. No Real Value: Testnet XRP and any Testnet units or representations of CalorieToken ($CAL) have **no monetary, redeemable, or transferable realโ€‘world value**. -3. No Advice: Nothing in the code, documentation, interfaces, commit history, issues, or generated outputs constitutes financial, investment, legal, medical, nutritional, or tax advice. Do your own due diligence. -4. No Solicitation: This repository does not solicit investment, purchase of tokens, securities, or any regulated financial instruments. -5. Risk Acceptance: You accept all risks associated with running beta code including potential data loss, malfunction, incorrect balances, performance issues, or security defects. -6. No Warranty: Provided "AS IS" without warranties of any kind (express or implied), including but not limited to merchantability, fitness for a particular purpose, nonโ€‘infringement, accuracy, reliability, or availability. -7. Limitation of Liability: CalorieToken, contributors, maintainers, and affiliates shall not be liable for any direct, indirect, incidental, consequential, special, exemplary, or punitive damages arising out of or in connection with use of or inability to use this beta software. -8. Intellectual Property: CalorieTokenยฎ trademarks, logos, and brand assets are protected. See `docs/TRADEMARK.md` for permitted usage. No license to brand assets is granted beyond the repositoryโ€™s stated custom dual license. -9. Data Handling: The current beta architecture stores sensitive wallet materials locally (encrypted). You are responsible for safeguarding keys, mnemonics, passwords, and exported data. No cloud custody is provided. -10. Security Posture: While reasonable hardening steps are taken, the software has not undergone formal thirdโ€‘party security audits. Treat all cryptographic operations as provisional. -11. Forwardโ€‘Looking Statements: Roadmap items, planned features, scaling targets, or performance goals are forwardโ€‘looking and inherently uncertain. -12. Jurisdiction: Usage is subject to applicable laws in your jurisdiction. If local regulations restrict interaction with beta blockchain software, you must discontinue use. -13. Contribution Disclosure: Pull requests, issues, or discussions may become publicly visible. Do not submit proprietary, confidential, or sensitive personal data. -14. Licensing: Current versions grant no new general licence. Earlier copies may retain rights validly granted under the historic custom licence. See `LICENSE`. -15. Monitoring: Public transparency of development is provided; you can review ongoing commits, branches, and releases at: https://github.com/CalorieToken/CalorieAppTestnet +- [Current reading guide](docs/OFFICIAL_PROJECT_DOCS.md) +- [Historical document index](docs/README.md) +- [Regulatory and product boundary](docs/REGULATORY_BOUNDARY.md) +- [Dated former README](docs/archive/README-before-2026-09-10.md) +- [Historical change log](docs/CHANGELOG.md) +- [Contribution terms](docs/CONTRIBUTING.md) -If you disagree with any clause, do not use, clone, build, or distribute this software. +## Rights and responsible use -**Contact (Licensing / Compliance / Security):** info@calorietoken.net +ICTHendrikse (KVK 73774693) administers rights in original material it created or lawfully acquired. Earlier references to Calorie Token VOF (KVK 84216352) are historical and do not prove transfer of every right. CalorieToken is identified by the project owner as an EU trade mark of Pieter Hendrikse; trade-mark rights are separate from regulatory authorisation. +Current versions grant no new general licence. Earlier copies may retain rights validly granted under their historical licence. See [LICENSE](LICENSE), [COPYRIGHT.md](COPYRIGHT.md), [NOTICE](NOTICE) and [trade-mark guidance](docs/TRADEMARK.md). Existing third-party rights and mandatory legal protections remain unaffected. +The prototype is experimental and may fail or lose data. Nothing here is financial, investment, medical, dietary, tax or legal advice. Do not put credentials, wallet recovery information or personal data into public issues. Start with the documentation; use the project's published security or privacy contact for a concern that requires it. -## ๐Ÿช™ CalorieToken Integration - -**Official CalorieToken XRPL Token:** -- **Currency:** Calorie -- **Ticker:** $CAL -- **Issuer:** `rNqGa93B8ewQP9mUwpwqA19SApbf62U7PY` -- **Network:** XRP Ledger Mainnet (Testnet for development) -- **Website:** [calorietoken.net](https://calorietoken.net) -- **Whitepaper:** [Read here](https://calorietoken.net/index.php/whitepaper/) - -> **"Aiming to be the world's food token"** -> This records the historical project direction. It does not claim that this -> Testnet repository currently provides payment services or has regulatory -> authorisation. - -**Learn More:** -- [Official Documentation Index](docs/OFFICIAL_PROJECT_DOCS.md) -- [Trademark Guidelines](docs/TRADEMARK.md) - Usage policies -- [CalorieToken Website](https://calorietoken.net) - Official resources - -## ๐ŸŒŸ High-Level Feature Matrix - -| Area | Implemented | Notes | -|------|-------------|-------| -| Multiโ€‘Wallet XRPL | โœ… | Create/import; encrypted storage | -| Mnemonic (BIP39) | โœ… | 12โ€‘word generation, verify, import | -| Token Support | โœ… | Generic framework + trustlines | -| Transactions | โœ… | XRP & tokens; visual history indicators | -| Offline Mode | โœ… | Deterministic tours/testing | -| Multiโ€‘Server Failover | โœ… | Rotating endpoints, graceful degradation | -| NFT Screens | โณ | Mint flow refinement pending | -| DEX Trading | โณ | Offer & market UI polishing | -| Food Tracking | โœ… | Nutrition logging baseline | -| Responsive System | โœ… | Size classes, lazy recompute, overlay (withheld) | -| Social Assets | โœ… | Dynamic image generator (edgeโ€‘toโ€‘edge typography) | -| Accessibility | ๐Ÿšง | Contrast audit scheduled | -| Performance Profiling | ๐Ÿšง | Planned instrumentation | -| CalorieDB Sync | ๐Ÿ”œ | Deferred (isolated) | -| WalletConnect | ๐Ÿ”œ | Phase 1 design queued | -| Web3 Browser | ๐Ÿ”œ | Deferred (flagged) | - -Legend: โœ… Complete ยท โณ Partial ยท ๐Ÿšง In Progress ยท ๐Ÿ”œ Planned - -## ๐Ÿ› ๏ธ Technical Stack - -- **Frontend**: KivyMD 2.0.dev (master) -- **Backend**: Python 3.12 -- **Blockchain**: XRPL (XRP Ledger) Testnet -- **Mnemonic**: BIP39 for 12-word recovery phrases -- **Networking**: httpx with async support -- **Encryption**: cryptography library -- **Data Storage**: shelve (encrypted) - -## ๐Ÿ—๏ธ Project Structure - -``` -CalorieAppTestnet/ -โ”œโ”€โ”€ README.md # You are here -โ”œโ”€โ”€ LICENSE # Custom dual license -โ”œโ”€โ”€ main.py # Application entry point -โ”œโ”€โ”€ requirements.txt # Python dependencies -โ”œโ”€โ”€ setup.py # Package configuration -โ”œโ”€โ”€ buildozer.spec # Android build config -โ”œโ”€โ”€ -โ”œโ”€โ”€ .github/ # CI/CD workflows -โ”œโ”€โ”€ assets/ # Images and resources -โ”œโ”€โ”€ docs/ # ๐Ÿ“š All documentation -โ”‚ โ”œโ”€โ”€ QUICK_START.md -โ”‚ โ”œโ”€โ”€ CONTRIBUTING.md -โ”‚ โ”œโ”€โ”€ CHANGELOG.md -โ”‚ โ”œโ”€โ”€ TODO.md -โ”‚ โ””โ”€โ”€ ... (guides & references) -โ”œโ”€โ”€ scripts/ # ๐Ÿ”ง Build & utility scripts -โ”‚ โ”œโ”€โ”€ ux_tour.py -โ”‚ โ”œโ”€โ”€ build_apk.bat -โ”‚ โ””โ”€โ”€ run.py -โ”œโ”€โ”€ src/ # ๐Ÿ’ป Source code -โ”‚ โ”œโ”€โ”€ VERSION.py -โ”‚ โ”œโ”€โ”€ core/ -โ”‚ โ”œโ”€โ”€ screens/ -โ”‚ โ””โ”€โ”€ utils/ -โ””โ”€โ”€ tests/ # ๐Ÿงช Unit tests -``` - -**Note**: We follow industry best practices with a clean root directory. Additional internal references are intentionally withheld until stable release. - -### Layout Organization (Modernized) -The UI is organized into maintainable, screen-focused KV files with a clear loading order. This approach improves iteration speed and keeps layouts consistent without exposing internal file structure. The modernized setup enables: -- Cleaner diffs and easier collaboration -- Reduced duplication and warnings -- Faster targeted layout updates - -### Conditional Navigation System -The app features an intelligent navigation system that creates navigation drawers only for screens that need them: - -**Screens WITH Navigation Drawers:** -- Wallet Screen -- Settings Screen -- Food Tracking Screen -- DEX Trading Screen -- NFT Minting Screen - -**Screens WITHOUT Navigation Drawers:** -- Login Screen -- Transaction Screens (Send XRP, Send Tokens) -- Setup/Import Screens -- Intro/First Use Screens -- Mnemonic Display/Verify Screens - -### XRPL Multi-Server Failover -Robust connectivity with automatic failover: -1. Primary: `https://testnet.xrpl-labs.com` -2. Backup: `https://s.altnet.rippletest.net:51234` -3. Backup: `https://testnet.xrplapi.com` -4. Backup: `https://xrplcluster.com` - -### XRPL Response Caching -Lightweight in-memory caching for select XRPL requests (e.g. `ServerInfo`) reduces redundant network calls and stabilizes performance under intermittent connectivity. Cache entries automatically expire after a short TTL. - -## ๐Ÿš€ Getting Started (Pre-Release Notice) -## โณ Deferred Components (Isolated) - -The following planned features are isolated under feature flags and excluded from the active beta build: - -- **Web3 Browser Screen** (`ENABLE_WEB3_BROWSER=False`): Future in-app browsing / WalletConnect surface. -- **CalorieDB Sync Layer** (`ENABLE_CALORIE_DB=False`): Planned decentralized product scan indexing (IPFS + BigchainDB). - - **XRPL โ†” CalorieDB Sync Service** (`ENABLE_CALORIE_DB=False`): Real-time bidirectional sync deferred; heavy integration code isolated. - -They reside in `src/_deferred/` and can be re-enabled via flags once scoped for a release milestone. - - -Runtime/build commands have been deliberately removed (v1.1.2) to prevent distribution of unfinished work. Request internal access: info@calorietoken.net. - -## ๐Ÿ“ฑ Usage - -### First Time Setup -1. Launch the app -2. Choose to create a new wallet or import existing keys -3. Set up your secure password -4. Your wallet is ready to use! - -### Sending Transactions -1. Navigate to the Wallet screen -2. Click "Send XRP" or token buttons -3. Enter recipient address and amount -4. Confirm transaction - -### Food Tracking -1. Access the Food Tracker from the navigation menu -2. Log your meals and track calories -3. Monitor your daily nutrition goals - -## ๐Ÿ”ง Development - -### Project Structure -``` -CalorieAppTestnet/ -โ”œโ”€โ”€ main.py # Application entry point -โ”œโ”€โ”€ run.py # Alternative run script -โ”œโ”€โ”€ buildozer.spec # Android build configuration -โ”œโ”€โ”€ requirements.txt # Python dependencies -โ”œโ”€โ”€ src/ -โ”‚ โ”œโ”€โ”€ core/ -โ”‚ โ”‚ โ”œโ”€โ”€ app.py # Main application class -โ”‚ โ”‚ โ””โ”€โ”€ kv/ # Modular KV layout files (replaces monolithic .kv) -โ”‚ โ”œโ”€โ”€ screens/ # All screen implementations -โ”‚ โ”‚ โ”œโ”€โ”€ WalletScreen.py -โ”‚ โ”‚ โ”œโ”€โ”€ SendXRPScreen.py -โ”‚ โ”‚ โ”œโ”€โ”€ SendTestTokenScreen.py -โ”‚ โ”‚ โ”œโ”€โ”€ MnemonicDisplayScreen.py -โ”‚ โ”‚ โ””โ”€โ”€ ... (25+ screens) -โ”‚ โ””โ”€โ”€ utils/ # Utility modules -โ”‚ โ”œโ”€โ”€ xrpl_client_manager.py # XRPL connectivity -โ”‚ โ”œโ”€โ”€ conditional_navigation.py # Navigation system -โ”‚ โ”œโ”€โ”€ mnemonic_manager.py # BIP39 mnemonic handling -โ”‚ โ”œโ”€โ”€ password_field_utils.py # UI utilities -โ”‚ โ”œโ”€โ”€ robust_transaction.py # Transaction handling -โ”‚ โ””โ”€โ”€ token_config.py # Token configuration -โ”œโ”€โ”€ assets/ # App assets and images -โ”‚ โ””โ”€โ”€ images/ # Logo and UI images -โ”œโ”€โ”€ config/ # Configuration files -โ”œโ”€โ”€ scripts/ # Utility scripts -โ””โ”€โ”€ docs/ # Documentation -``` - -### Key Components - -- **`XRPLClientManager`**: Handles XRPL connectivity with automatic failover -- **`ConditionalNavigationDrawer`**: Intelligent navigation system -- **`PasswordFieldWithToggle`**: Enhanced password input with visibility toggle -- **`robust_submit_and_wait`**: Transaction submission with retry logic - -### Development Viewport & Responsive Overrides -During active development and automated UX tours we often want a consistent, phone-sized viewport while still preserving full adaptive behavior for tablets and desktops in production. - -Environment overrides (all optional): - -| Variable | Example | Purpose | -|----------|---------|---------| -| `DEV_PHONE_VIEWPORT` | `390x844` | Forces window size (if `APP_FORCE_WIDTH/HEIGHT` not set) to a modern phone logical resolution (portrait enforced). | -| `FORCE_SIZE_CLASS` | `sm` / `phone` | Pins responsive size class regardless of window width (use `phone` as alias for `sm`). | -| `TOUR_FORCE_PHONE` | `1` | In UX tour runs auto-sets `DEV_PHONE_VIEWPORT=390x844` and `FORCE_SIZE_CLASS=sm` if unset. | -| `TOUR_PHONE_WIDTH` / `TOUR_PHONE_HEIGHT` | `414` / `896` | Fine-grained control for UX tour window size when `TOUR_FORCE_PHONE` is enabled. | - -Example (PowerShell): -```powershell -$env:DEV_PHONE_VIEWPORT="390x844"; $env:FORCE_SIZE_CLASS="sm"; python -B scripts/complete_ux_tour.py -``` - -Production builds simply omit these variables and the app reverts to automatic breakpoint detection (`xs`, `sm`, `md`, `lg`, `xl`). The responsive system caches scaling factors to minimize recomputation while keeping layout adjustments correct on window resize. - -Breakpoints remain unchanged ensuring cross-platform compatibility; overrides are strictly opt-in for development convenience. - -### Debug Overlay (Development Only) -Activation mechanics exist but invocation commands are withheld pre-release. Overlay shows breakpoint class, scaling factors, and dimensions when enabled internally. - -This displays a small badge in the top-right corner showing: -- Current size class (xs/sm/md/lg/xl) -- Lock icon (๐Ÿ”’) when `FORCE_SIZE_CLASS` is active -- DP and font scale factors -- Current window dimensions - -The overlay updates in real-time during window resizes and is automatically removed in production (when `DEBUG_RESPONSIVE` is unset). - -### CI Testing Strategy -Automated UX validation runs are supported to help catch regressions across device sizes. Details of internal test tooling are intentionally minimized here for security and competitive reasons. See `docs/UX_TOUR_GUIDE.md` for a public overview of the process. - -## ๐Ÿงช Testing - -### Automated UX Tour -We use an automated UX tour to validate major screens and flows and to generate visual reports for review. High-level, public-safe documentation is available here: - -- [UX Tour Guide](docs/UX_TOUR_GUIDE.md) - -Implementation details and internal scripts are withheld to protect the projectโ€™s integrity until formal release. - -See also: -- [Project Status](docs/PROJECT_STATUS.md) - Current development state -- [Changelog](docs/CHANGELOG.md) - Version history -- [Roadmap](docs/TODO.md) - Future plans - -### UI/UX References (Public) -- KivyMD Documentation: https://kivymd.readthedocs.io/ -- Kivy Documentation: https://kivy.org/doc/stable/ -- Material Design 3: https://m3.material.io/ - -### Manual Testing -Internal test cycles include navigation, XRPL connectivity/failover simulation, wallet creation/import flows, transaction lifecycle validation, performance sampling, and offline mode handling. Detailed invocation steps are withheld until stable release. - -## ๐Ÿค Contributing - -We welcome contributions! Please read our [Contributing Guide](docs/CONTRIBUTING.md) for: -- Code style guidelines -- Development setup -- Testing requirements -- Pull request process - -## ๐Ÿ“„ License - -Current repository versions are subject to the prospective rights reservation -in [LICENSE](LICENSE). Earlier copies may retain rights validly granted under -the historical custom 2023-2025 licence. - -No new general permission to use, publish, distribute, or commercialize the -current version is granted. - -**Contact for commercial licensing:** info@calorietoken.net - -**Trademark Notice:** CalorieToken is a registered EU trade mark owned by -Pieter Hendrikse. See [TRADEMARK.md](docs/TRADEMARK.md). - -## ๐ŸŒ XRPL Testnet - -This application uses the XRPL Testnet for development and testing. Testnet XRP has no real-world value and is used solely for testing purposes. - -## ๐Ÿ”— Links - -### Official CalorieToken Resources -- [CalorieToken Website](https://calorietoken.net) -- [Whitepaper](https://calorietoken.net/index.php/whitepaper/) -- [Twitter/X](https://twitter.com/CalorieToken) -- [Telegram Community](https://t.me/+7YxaKdQYWNA0NDA0) -- [Discord Developers](https://discord.gg/hcjJgdyDGd) -- [All Links (Linktree)](https://linktr.ee/CalorieToken) - -### Technical Documentation -- [XRPL Documentation](https://xrpl.org/) -- [KivyMD Documentation](https://kivymd.readthedocs.io/) -- [Buildozer Documentation](https://buildozer.readthedocs.io/) - -### Trading & Token Info -- [Sologenic DEX](https://sologenic.org/trade?network=mainnet&market=43616C6F72696500000000000000000000000000%2BrNqGa93B8ewQP9mUwpwqA19SApbf62U7PY%2FXRP) -- [XPMarket](https://xpmarket.com/token/Calorie-rNqGa93B8ewQP9mUwpwqA19SApbf62U7PY) -- [LiveCoinWatch](https://www.livecoinwatch.com/price/Calorie-CAL) - -## ๐Ÿ†˜ Support - -**For App/Development Issues:** -- Open an issue on [GitHub](https://github.com/CalorieToken/CalorieAppTestnet/issues) -- Check the [documentation](docs/README.md) -- Join [Discord Developers Server](https://discord.gg/hcjJgdyDGd) - -**For CalorieToken Project:** -- Email: info@calorietoken.net -- Telegram: [Community Chat](https://t.me/+7YxaKdQYWNA0NDA0) -- Twitter: [@CalorieToken](https://twitter.com/CalorieToken) - ---- - -**Built with โค๏ธ for CalorieToken and the XRPL community** - ---- - -**CalorieToken | Registered EU trade mark of Pieter Hendrikse** -*Software rights administered by ICTHendrikse (KvK 73774693), limited to rights actually held.* +Documentation reviewed: **10 September 2026**. This revision changes public interpretation and navigation, not executable code, licences, historical test results or deployment. diff --git a/docs/OFFICIAL_PROJECT_DOCS.md b/docs/OFFICIAL_PROJECT_DOCS.md index a3daf41..df10636 100644 --- a/docs/OFFICIAL_PROJECT_DOCS.md +++ b/docs/OFFICIAL_PROJECT_DOCS.md @@ -1,63 +1,18 @@ -# Official Project Documentation +# CalorieApp Testnet: reading guide -Last Updated: 2025-11-18 -Version: 1.1.0 +Updated 10 September 2026. This is the public entry point for the historical prototype, not a deployment guide for the current app. -This document is the canonical, public-safe entry point for CalorieApp Testnet documentation. It consolidates high-level information for users, contributors, and partners while keeping implementation details private until stable release. +The current **CalorieApp V2** is a separate food and nutrition webapp. Its [source and documentation](https://github.com/CalorieToken/CalorieApp) and [current publications](https://github.com/CalorieToken/Publications) describe that scope. This repository's wallet, transaction, DEX and NFT material remains historical Testnet experimentation. -## Overview +| Read | Purpose | +| --- | --- | +| [Repository overview](../README.md) | Historical status, current links and rights | +| [Regulatory boundary](REGULATORY_BOUNDARY.md) | Separation from current food-app and regulated-service claims | +| [Historical document index](README.md) | Dated development material | +| [Change log](CHANGELOG.md) | Changes recorded for older builds | +| [Licence](../LICENSE) | Current rights reservation and the treatment of earlier grants | +| [Trade marks](TRADEMARK.md) | Brand scope, separate from financial authorisation | -CalorieApp is a mobile-first wallet and food tracking application integrated with CalorieToken on the XRP Ledger. The app targets practical payments and nutrition tracking with a focus on performance and usability. +The website's newer Testnet guide does not activate this legacy runtime or turn a test account into a pilot entitlement. The Community Voting Hub is informational: no voting or proposal submission is active. Screenshots, diagrams and old mainnet directions are preserved as history, not recommendations to use real assets. -- Platform: Python 3.12, KivyMD 2.0 -- Network: XRPL Testnet (development), Mainnet-ready -- Status: Active Beta development -- Licence: current prospective rights reservation; historic grants may remain valid for older copies (see LICENSE) -- Trademark: CalorieTokenยฎ (EUIPO registered) - - Legal Disclaimer: See `docs/LEGAL_DISCLAIMER.md` - -## Highlights - -- Multi-wallet XRPL support (create/import) -- XRP and token transactions with robust connectivity -- Trustline management -- NFT and DEX screens (in development) -- Food tracking features -- Automated UX Tour (public-safe overview) - -## Getting Started (Public-Safe) - -Execution and packaging instructions are intentionally withheld while in active Beta. Prior run/build examples removed to discourage use of unfinished components. - -## Key Documents - -- Project README: `README.md` -- Changelog: `docs/CHANGELOG.md` -- UX Tour Guide (public-safe): `docs/UX_TOUR_GUIDE.md` -- Legal: `LICENSE`, `docs/TRADEMARK.md` - -## Links - -- Website: https://calorietoken.net -- Whitepaper: https://calorietoken.net/index.php/whitepaper/ -- Twitter/X: https://twitter.com/CalorieToken -- Telegram: https://t.me/+7YxaKdQYWNA0NDA0 - -## Privacy & Security - -- Internal implementation details and research references are intentionally excluded from this public repository snapshot to prevent copying and to protect competitive advantages. -- Public docs focus on high-level capabilities and safe operational guidance. -- Detailed technical integrations, test artifacts, and analysis outputs remain private until stable release. - -## Roadmap Snapshot (Public) - -- Beta polish and stability improvements -- Accessibility and performance tuning -- Expanded transaction UX -- Finalize Android packaging flow - -For additional information or partnership inquiries, contact: info@calorietoken.net - -## Disclaimer (Public-Safe) - -CalorieApp is an active beta operating on the XRP Ledger Testnet. Features, data models, and UX flows may change without notice prior to any mainnet release. Testnet XRP and testnet CalorieToken ($CAL) units have no monetary value. Nothing herein constitutes financial, investment, dietary, medical, tax, or legal advice. Review extended clauses: `docs/LEGAL_DISCLAIMER.md`. +No executable code or production configuration changes with this document update. Never submit seeds, private keys or personal records to public documentation or issues. diff --git a/docs/README.md b/docs/README.md index 666ef2d..dd8c9a5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # CalorieApp Testnet Documentation -Welcome to the CalorieApp Testnet documentation. This directory contains comprehensive guides and references for developers and users. +**Historical reference index - reviewed 10 September 2026.** These guides describe their original prototype/build. They are not current operational instructions or evidence that wallet, DEX or NFT functionality is active in CalorieApp V2. Start with the [current reading guide](OFFICIAL_PROJECT_DOCS.md). ## ๐Ÿ“š Documentation Index @@ -32,66 +32,10 @@ Welcome to the CalorieApp Testnet documentation. This directory contains compreh ### Legal & Licensing - **[Trademark Guidelines](TRADEMARK.md)** - CalorieTokenยฎ trademark usage policy โš ๏ธ -- **[License](../LICENSE)** - Custom dual license terms +- **[License](../LICENSE)** - Current rights reservation; earlier valid grants remain separate ### Archive The `archive/` directory contains historical completion reports and development progress documentation for reference. -## ๐Ÿš€ Quick Links -### Getting Started -1. Clone the repository -2. Install dependencies: `pip install -r requirements.txt` -3. Run the app: `python run.py` - -### Building for Android -1. Install buildozer: `pip install buildozer` -2. Build APK: `buildozer android debug` - -### Key Features -- ๐Ÿ” Multi-wallet XRPL support -- ๐Ÿ”‘ 12-word mnemonic recovery phrases -- ๐Ÿ’ธ XRP and custom token transactions -- ๐ŸŽจ NFT minting capabilities -- ๐Ÿ“Š DEX trading interface -- ๐Ÿฝ๏ธ Food tracking features -- ๐Ÿงญ Conditional navigation system -- ๐ŸŽจ Modern unified UI layout -- ๐Ÿงช 97 automated UI/UX tests (100% pass rate) โญ NEW -- ๐ŸŒ Multi-server XRPL failover with offline mode โญ NEW - -## ๐Ÿ“– Documentation Standards - -All documentation follows these principles: -- **Clear**: Easy to understand for all skill levels -- **Comprehensive**: Covers all aspects thoroughly -- **Current**: Updated with latest changes -- **Practical**: Includes examples and use cases - -## ๐Ÿค Contributing - -When contributing documentation: -1. Use clear, concise language -2. Include code examples where applicable -3. Add screenshots for UI-related documentation -4. Update the changelog for significant changes -5. Follow the existing documentation structure - -## ๐Ÿ“ž Support - -For questions or issues: -- Check existing documentation first -- Review the [Troubleshooting Guide](FAUCET_TROUBLESHOOTING.md) -- Open an issue on GitHub -- Contact via Twitter: [@CalorieToken](https://twitter.com/CalorieToken) - -## ๐Ÿ“„ License - -Current CalorieAppTestnet versions grant no new general licence. Earlier copies -may retain rights validly granted under the historical custom licence. See -`../LICENSE`. - ---- - -**Last Updated:** November 18, 2025 -**Version:** 1.1.0 +For the current webapp, use [CalorieApp V2](https://github.com/CalorieToken/CalorieApp). [Earlier README](archive/README-before-2026-09-10.md) preserves the dated feature and test statements without claiming they were rerun in this update. diff --git a/docs/REGULATORY_BOUNDARY.md b/docs/REGULATORY_BOUNDARY.md index 14e1a5b..a78940d 100644 --- a/docs/REGULATORY_BOUNDARY.md +++ b/docs/REGULATORY_BOUNDARY.md @@ -1,9 +1,9 @@ # Regulatory and product boundary -Last updated: 25 August 2026 +Last updated: 10 September 2026 This repository preserves an experimental, historical XRP Ledger Testnet -prototype. It is not the current CalorieApp V1 production runtime and it must +prototype. It is not the current CalorieApp V2 production runtime and it must not be presented as a live wallet, exchange, payment service, investment product, or other professional crypto-asset service. @@ -18,12 +18,12 @@ advice, or operate a trading platform. No maintained, production-ready, or regulator-approved status is claimed. Do not use this prototype with mainnet credentials or assets. -## Separation from current CalorieApp V1 +## Separation from current CalorieApp V2 -Current CalorieApp V1 is a separate non-financial, non-custodial food and +Current CalorieApp V2 is a separate non-financial, non-custodial food and nutrition web application. No wallet custody or financial transaction layer is -claimed in V1. Historical Testnet capabilities in this repository are not -evidence that those capabilities exist in current V1. +claimed in V2. Historical Testnet capabilities in this repository are not +evidence that those capabilities exist in current V2. ## MiCA and trade-mark distinction diff --git a/docs/archive/README-before-2026-09-10.md b/docs/archive/README-before-2026-09-10.md new file mode 100644 index 0000000..e0d47d9 --- /dev/null +++ b/docs/archive/README-before-2026-09-10.md @@ -0,0 +1,367 @@ +# CalorieApp ๐ŸŽ + +[![CI](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ci.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ci.yml) +[![CodeQL](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/codeql.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/codeql.yml) +[![UX Tour](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ux_tour.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ux_tour.yml) +[![Version](https://img.shields.io/badge/version-1.1.2-blue.svg)](https://github.com/CalorieToken/CalorieAppTestnet) +[![Python](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/) +[![License](https://img.shields.io/badge/license-Custom%20Dual-orange.svg)](LICENSE) +[![Website](https://img.shields.io/badge/website-calorietoken.net-green.svg)](https://calorietoken.net) +[![XRPL](https://img.shields.io/badge/XRPL-Mainnet%20%26%20Testnet-blue.svg)](https://xrpl.org/) + +A mobile-first cryptocurrency wallet and food tracking application for **CalorieToken** on the XRP Ledger, built with KivyMD. + +> **Rights correction (2026):** ICTHendrikse (KvK 73774693) administers +> rights in original portions it created or lawfully acquired. CalorieToken is +> a registered EU trade mark owned by Pieter Hendrikse. Earlier references to +> Calorie Token VOF (KvK 84216352) are historical and do not by themselves +> prove transfer of every IP right. See `LICENSE`, `COPYRIGHT.md`, and `NOTICE`. + +> **Regulatory boundary:** this is a historical, experimental XRP Ledger +> Testnet prototype, not the current CalorieApp V1 production runtime and not a +> live wallet, exchange, payment service, or investment product. See +> [`docs/REGULATORY_BOUNDARY.md`](docs/REGULATORY_BOUNDARY.md). + +> **Latest Update (2025-11-18 โ€“ v1.1.1):** Repository hardening, public-safe documentation index, UX layout consistency, security enhancements. See [CHANGELOG](docs/CHANGELOG.md#111---2025-11-18). Pending merge from branch `chore/repo-hardening`. + +## โš–๏ธ Legal & Beta Testnet Disclaimer + +This software ("CalorieApp") is a preโ€‘release **beta** operating solely on the XRP Ledger **Testnet**. By accessing, cloning, building, or using any portion of this repository you acknowledge and agree to the following clauses: + +1. Experimental Status: All features (wallets, tokens, NFT, DEX, food tracking, UI components) are experimental and subject to modification, suspension, or removal without notice prior to any mainnet launch. +2. No Real Value: Testnet XRP and any Testnet units or representations of CalorieToken ($CAL) have **no monetary, redeemable, or transferable realโ€‘world value**. +3. No Advice: Nothing in the code, documentation, interfaces, commit history, issues, or generated outputs constitutes financial, investment, legal, medical, nutritional, or tax advice. Do your own due diligence. +4. No Solicitation: This repository does not solicit investment, purchase of tokens, securities, or any regulated financial instruments. +5. Risk Acceptance: You accept all risks associated with running beta code including potential data loss, malfunction, incorrect balances, performance issues, or security defects. +6. No Warranty: Provided "AS IS" without warranties of any kind (express or implied), including but not limited to merchantability, fitness for a particular purpose, nonโ€‘infringement, accuracy, reliability, or availability. +7. Limitation of Liability: CalorieToken, contributors, maintainers, and affiliates shall not be liable for any direct, indirect, incidental, consequential, special, exemplary, or punitive damages arising out of or in connection with use of or inability to use this beta software. +8. Intellectual Property: CalorieTokenยฎ trademarks, logos, and brand assets are protected. See `docs/TRADEMARK.md` for permitted usage. No license to brand assets is granted beyond the repositoryโ€™s stated custom dual license. +9. Data Handling: The current beta architecture stores sensitive wallet materials locally (encrypted). You are responsible for safeguarding keys, mnemonics, passwords, and exported data. No cloud custody is provided. +10. Security Posture: While reasonable hardening steps are taken, the software has not undergone formal thirdโ€‘party security audits. Treat all cryptographic operations as provisional. +11. Forwardโ€‘Looking Statements: Roadmap items, planned features, scaling targets, or performance goals are forwardโ€‘looking and inherently uncertain. +12. Jurisdiction: Usage is subject to applicable laws in your jurisdiction. If local regulations restrict interaction with beta blockchain software, you must discontinue use. +13. Contribution Disclosure: Pull requests, issues, or discussions may become publicly visible. Do not submit proprietary, confidential, or sensitive personal data. +14. Licensing: Current versions grant no new general licence. Earlier copies may retain rights validly granted under the historic custom licence. See `LICENSE`. +15. Monitoring: Public transparency of development is provided; you can review ongoing commits, branches, and releases at: https://github.com/CalorieToken/CalorieAppTestnet + +If you disagree with any clause, do not use, clone, build, or distribute this software. + +**Contact (Licensing / Compliance / Security):** info@calorietoken.net + + + +## ๐Ÿช™ CalorieToken Integration + +**Official CalorieToken XRPL Token:** +- **Currency:** Calorie +- **Ticker:** $CAL +- **Issuer:** `rNqGa93B8ewQP9mUwpwqA19SApbf62U7PY` +- **Network:** XRP Ledger Mainnet (Testnet for development) +- **Website:** [calorietoken.net](https://calorietoken.net) +- **Whitepaper:** [Read here](https://calorietoken.net/index.php/whitepaper/) + +> **"Aiming to be the world's food token"** +> This records the historical project direction. It does not claim that this +> Testnet repository currently provides payment services or has regulatory +> authorisation. + +**Learn More:** +- [Official Documentation Index](docs/OFFICIAL_PROJECT_DOCS.md) +- [Trademark Guidelines](docs/TRADEMARK.md) - Usage policies +- [CalorieToken Website](https://calorietoken.net) - Official resources + +## ๐ŸŒŸ High-Level Feature Matrix + +| Area | Implemented | Notes | +|------|-------------|-------| +| Multiโ€‘Wallet XRPL | โœ… | Create/import; encrypted storage | +| Mnemonic (BIP39) | โœ… | 12โ€‘word generation, verify, import | +| Token Support | โœ… | Generic framework + trustlines | +| Transactions | โœ… | XRP & tokens; visual history indicators | +| Offline Mode | โœ… | Deterministic tours/testing | +| Multiโ€‘Server Failover | โœ… | Rotating endpoints, graceful degradation | +| NFT Screens | โณ | Mint flow refinement pending | +| DEX Trading | โณ | Offer & market UI polishing | +| Food Tracking | โœ… | Nutrition logging baseline | +| Responsive System | โœ… | Size classes, lazy recompute, overlay (withheld) | +| Social Assets | โœ… | Dynamic image generator (edgeโ€‘toโ€‘edge typography) | +| Accessibility | ๐Ÿšง | Contrast audit scheduled | +| Performance Profiling | ๐Ÿšง | Planned instrumentation | +| CalorieDB Sync | ๐Ÿ”œ | Deferred (isolated) | +| WalletConnect | ๐Ÿ”œ | Phase 1 design queued | +| Web3 Browser | ๐Ÿ”œ | Deferred (flagged) | + +Legend: โœ… Complete ยท โณ Partial ยท ๐Ÿšง In Progress ยท ๐Ÿ”œ Planned + +## ๐Ÿ› ๏ธ Technical Stack + +- **Frontend**: KivyMD 2.0.dev (master) +- **Backend**: Python 3.12 +- **Blockchain**: XRPL (XRP Ledger) Testnet +- **Mnemonic**: BIP39 for 12-word recovery phrases +- **Networking**: httpx with async support +- **Encryption**: cryptography library +- **Data Storage**: shelve (encrypted) + +## ๐Ÿ—๏ธ Project Structure + +``` +CalorieAppTestnet/ +โ”œโ”€โ”€ README.md # You are here +โ”œโ”€โ”€ LICENSE # Custom dual license +โ”œโ”€โ”€ main.py # Application entry point +โ”œโ”€โ”€ requirements.txt # Python dependencies +โ”œโ”€โ”€ setup.py # Package configuration +โ”œโ”€โ”€ buildozer.spec # Android build config +โ”œโ”€โ”€ +โ”œโ”€โ”€ .github/ # CI/CD workflows +โ”œโ”€โ”€ assets/ # Images and resources +โ”œโ”€โ”€ docs/ # ๐Ÿ“š All documentation +โ”‚ โ”œโ”€โ”€ QUICK_START.md +โ”‚ โ”œโ”€โ”€ CONTRIBUTING.md +โ”‚ โ”œโ”€โ”€ CHANGELOG.md +โ”‚ โ”œโ”€โ”€ TODO.md +โ”‚ โ””โ”€โ”€ ... (guides & references) +โ”œโ”€โ”€ scripts/ # ๐Ÿ”ง Build & utility scripts +โ”‚ โ”œโ”€โ”€ ux_tour.py +โ”‚ โ”œโ”€โ”€ build_apk.bat +โ”‚ โ””โ”€โ”€ run.py +โ”œโ”€โ”€ src/ # ๐Ÿ’ป Source code +โ”‚ โ”œโ”€โ”€ VERSION.py +โ”‚ โ”œโ”€โ”€ core/ +โ”‚ โ”œโ”€โ”€ screens/ +โ”‚ โ””โ”€โ”€ utils/ +โ””โ”€โ”€ tests/ # ๐Ÿงช Unit tests +``` + +**Note**: We follow industry best practices with a clean root directory. Additional internal references are intentionally withheld until stable release. + +### Layout Organization (Modernized) +The UI is organized into maintainable, screen-focused KV files with a clear loading order. This approach improves iteration speed and keeps layouts consistent without exposing internal file structure. The modernized setup enables: +- Cleaner diffs and easier collaboration +- Reduced duplication and warnings +- Faster targeted layout updates + +### Conditional Navigation System +The app features an intelligent navigation system that creates navigation drawers only for screens that need them: + +**Screens WITH Navigation Drawers:** +- Wallet Screen +- Settings Screen +- Food Tracking Screen +- DEX Trading Screen +- NFT Minting Screen + +**Screens WITHOUT Navigation Drawers:** +- Login Screen +- Transaction Screens (Send XRP, Send Tokens) +- Setup/Import Screens +- Intro/First Use Screens +- Mnemonic Display/Verify Screens + +### XRPL Multi-Server Failover +Robust connectivity with automatic failover: +1. Primary: `https://testnet.xrpl-labs.com` +2. Backup: `https://s.altnet.rippletest.net:51234` +3. Backup: `https://testnet.xrplapi.com` +4. Backup: `https://xrplcluster.com` + +### XRPL Response Caching +Lightweight in-memory caching for select XRPL requests (e.g. `ServerInfo`) reduces redundant network calls and stabilizes performance under intermittent connectivity. Cache entries automatically expire after a short TTL. + +## ๐Ÿš€ Getting Started (Pre-Release Notice) +## โณ Deferred Components (Isolated) + +The following planned features are isolated under feature flags and excluded from the active beta build: + +- **Web3 Browser Screen** (`ENABLE_WEB3_BROWSER=False`): Future in-app browsing / WalletConnect surface. +- **CalorieDB Sync Layer** (`ENABLE_CALORIE_DB=False`): Planned decentralized product scan indexing (IPFS + BigchainDB). + - **XRPL โ†” CalorieDB Sync Service** (`ENABLE_CALORIE_DB=False`): Real-time bidirectional sync deferred; heavy integration code isolated. + +They reside in `src/_deferred/` and can be re-enabled via flags once scoped for a release milestone. + + +Runtime/build commands have been deliberately removed (v1.1.2) to prevent distribution of unfinished work. Request internal access: info@calorietoken.net. + +## ๐Ÿ“ฑ Usage + +### First Time Setup +1. Launch the app +2. Choose to create a new wallet or import existing keys +3. Set up your secure password +4. Your wallet is ready to use! + +### Sending Transactions +1. Navigate to the Wallet screen +2. Click "Send XRP" or token buttons +3. Enter recipient address and amount +4. Confirm transaction + +### Food Tracking +1. Access the Food Tracker from the navigation menu +2. Log your meals and track calories +3. Monitor your daily nutrition goals + +## ๐Ÿ”ง Development + +### Project Structure +``` +CalorieAppTestnet/ +โ”œโ”€โ”€ main.py # Application entry point +โ”œโ”€โ”€ run.py # Alternative run script +โ”œโ”€โ”€ buildozer.spec # Android build configuration +โ”œโ”€โ”€ requirements.txt # Python dependencies +โ”œโ”€โ”€ src/ +โ”‚ โ”œโ”€โ”€ core/ +โ”‚ โ”‚ โ”œโ”€โ”€ app.py # Main application class +โ”‚ โ”‚ โ””โ”€โ”€ kv/ # Modular KV layout files (replaces monolithic .kv) +โ”‚ โ”œโ”€โ”€ screens/ # All screen implementations +โ”‚ โ”‚ โ”œโ”€โ”€ WalletScreen.py +โ”‚ โ”‚ โ”œโ”€โ”€ SendXRPScreen.py +โ”‚ โ”‚ โ”œโ”€โ”€ SendTestTokenScreen.py +โ”‚ โ”‚ โ”œโ”€โ”€ MnemonicDisplayScreen.py +โ”‚ โ”‚ โ””โ”€โ”€ ... (25+ screens) +โ”‚ โ””โ”€โ”€ utils/ # Utility modules +โ”‚ โ”œโ”€โ”€ xrpl_client_manager.py # XRPL connectivity +โ”‚ โ”œโ”€โ”€ conditional_navigation.py # Navigation system +โ”‚ โ”œโ”€โ”€ mnemonic_manager.py # BIP39 mnemonic handling +โ”‚ โ”œโ”€โ”€ password_field_utils.py # UI utilities +โ”‚ โ”œโ”€โ”€ robust_transaction.py # Transaction handling +โ”‚ โ””โ”€โ”€ token_config.py # Token configuration +โ”œโ”€โ”€ assets/ # App assets and images +โ”‚ โ””โ”€โ”€ images/ # Logo and UI images +โ”œโ”€โ”€ config/ # Configuration files +โ”œโ”€โ”€ scripts/ # Utility scripts +โ””โ”€โ”€ docs/ # Documentation +``` + +### Key Components + +- **`XRPLClientManager`**: Handles XRPL connectivity with automatic failover +- **`ConditionalNavigationDrawer`**: Intelligent navigation system +- **`PasswordFieldWithToggle`**: Enhanced password input with visibility toggle +- **`robust_submit_and_wait`**: Transaction submission with retry logic + +### Development Viewport & Responsive Overrides +During active development and automated UX tours we often want a consistent, phone-sized viewport while still preserving full adaptive behavior for tablets and desktops in production. + +Environment overrides (all optional): + +| Variable | Example | Purpose | +|----------|---------|---------| +| `DEV_PHONE_VIEWPORT` | `390x844` | Forces window size (if `APP_FORCE_WIDTH/HEIGHT` not set) to a modern phone logical resolution (portrait enforced). | +| `FORCE_SIZE_CLASS` | `sm` / `phone` | Pins responsive size class regardless of window width (use `phone` as alias for `sm`). | +| `TOUR_FORCE_PHONE` | `1` | In UX tour runs auto-sets `DEV_PHONE_VIEWPORT=390x844` and `FORCE_SIZE_CLASS=sm` if unset. | +| `TOUR_PHONE_WIDTH` / `TOUR_PHONE_HEIGHT` | `414` / `896` | Fine-grained control for UX tour window size when `TOUR_FORCE_PHONE` is enabled. | + +Example (PowerShell): +```powershell +$env:DEV_PHONE_VIEWPORT="390x844"; $env:FORCE_SIZE_CLASS="sm"; python -B scripts/complete_ux_tour.py +``` + +Production builds simply omit these variables and the app reverts to automatic breakpoint detection (`xs`, `sm`, `md`, `lg`, `xl`). The responsive system caches scaling factors to minimize recomputation while keeping layout adjustments correct on window resize. + +Breakpoints remain unchanged ensuring cross-platform compatibility; overrides are strictly opt-in for development convenience. + +### Debug Overlay (Development Only) +Activation mechanics exist but invocation commands are withheld pre-release. Overlay shows breakpoint class, scaling factors, and dimensions when enabled internally. + +This displays a small badge in the top-right corner showing: +- Current size class (xs/sm/md/lg/xl) +- Lock icon (๐Ÿ”’) when `FORCE_SIZE_CLASS` is active +- DP and font scale factors +- Current window dimensions + +The overlay updates in real-time during window resizes and is automatically removed in production (when `DEBUG_RESPONSIVE` is unset). + +### CI Testing Strategy +Automated UX validation runs are supported to help catch regressions across device sizes. Details of internal test tooling are intentionally minimized here for security and competitive reasons. See `docs/UX_TOUR_GUIDE.md` for a public overview of the process. + +## ๐Ÿงช Testing + +### Automated UX Tour +We use an automated UX tour to validate major screens and flows and to generate visual reports for review. High-level, public-safe documentation is available here: + +- [UX Tour Guide](docs/UX_TOUR_GUIDE.md) + +Implementation details and internal scripts are withheld to protect the projectโ€™s integrity until formal release. + +See also: +- [Project Status](docs/PROJECT_STATUS.md) - Current development state +- [Changelog](docs/CHANGELOG.md) - Version history +- [Roadmap](docs/TODO.md) - Future plans + +### UI/UX References (Public) +- KivyMD Documentation: https://kivymd.readthedocs.io/ +- Kivy Documentation: https://kivy.org/doc/stable/ +- Material Design 3: https://m3.material.io/ + +### Manual Testing +Internal test cycles include navigation, XRPL connectivity/failover simulation, wallet creation/import flows, transaction lifecycle validation, performance sampling, and offline mode handling. Detailed invocation steps are withheld until stable release. + +## ๐Ÿค Contributing + +We welcome contributions! Please read our [Contributing Guide](docs/CONTRIBUTING.md) for: +- Code style guidelines +- Development setup +- Testing requirements +- Pull request process + +## ๐Ÿ“„ License + +Current repository versions are subject to the prospective rights reservation +in [LICENSE](LICENSE). Earlier copies may retain rights validly granted under +the historical custom 2023-2025 licence. + +No new general permission to use, publish, distribute, or commercialize the +current version is granted. + +**Contact for commercial licensing:** info@calorietoken.net + +**Trademark Notice:** CalorieToken is a registered EU trade mark owned by +Pieter Hendrikse. See [TRADEMARK.md](docs/TRADEMARK.md). + +## ๐ŸŒ XRPL Testnet + +This application uses the XRPL Testnet for development and testing. Testnet XRP has no real-world value and is used solely for testing purposes. + +## ๐Ÿ”— Links + +### Official CalorieToken Resources +- [CalorieToken Website](https://calorietoken.net) +- [Whitepaper](https://calorietoken.net/index.php/whitepaper/) +- [Twitter/X](https://twitter.com/CalorieToken) +- [Telegram Community](https://t.me/+7YxaKdQYWNA0NDA0) +- [Discord Developers](https://discord.gg/hcjJgdyDGd) +- [All Links (Linktree)](https://linktr.ee/CalorieToken) + +### Technical Documentation +- [XRPL Documentation](https://xrpl.org/) +- [KivyMD Documentation](https://kivymd.readthedocs.io/) +- [Buildozer Documentation](https://buildozer.readthedocs.io/) + +### Trading & Token Info +- [Sologenic DEX](https://sologenic.org/trade?network=mainnet&market=43616C6F72696500000000000000000000000000%2BrNqGa93B8ewQP9mUwpwqA19SApbf62U7PY%2FXRP) +- [XPMarket](https://xpmarket.com/token/Calorie-rNqGa93B8ewQP9mUwpwqA19SApbf62U7PY) +- [LiveCoinWatch](https://www.livecoinwatch.com/price/Calorie-CAL) + +## ๐Ÿ†˜ Support + +**For App/Development Issues:** +- Open an issue on [GitHub](https://github.com/CalorieToken/CalorieAppTestnet/issues) +- Check the [documentation](docs/README.md) +- Join [Discord Developers Server](https://discord.gg/hcjJgdyDGd) + +**For CalorieToken Project:** +- Email: info@calorietoken.net +- Telegram: [Community Chat](https://t.me/+7YxaKdQYWNA0NDA0) +- Twitter: [@CalorieToken](https://twitter.com/CalorieToken) + +--- + +**Built with โค๏ธ for CalorieToken and the XRPL community** + +--- + +**CalorieToken | Registered EU trade mark of Pieter Hendrikse** +*Software rights administered by ICTHendrikse (KvK 73774693), limited to rights actually held.* From 8b991513620f540eaba4df0d5f77a2e7cc473faa Mon Sep 17 00:00:00 2001 From: xrpbanks <126300068+xrpbanks@users.noreply.github.com> Date: Thu, 10 Sep 2026 16:08:53 +0200 Subject: [PATCH 2/2] Explain archived relative links and align operator spelling --- README.md | 4 +++- docs/README.md | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7a4cfd..e42cbfe 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,12 @@ Testnet assets have no real monetary or redeemable value, and the network can re ## Rights and responsible use -ICTHendrikse (KVK 73774693) administers rights in original material it created or lawfully acquired. Earlier references to Calorie Token VOF (KVK 84216352) are historical and do not prove transfer of every right. CalorieToken is identified by the project owner as an EU trade mark of Pieter Hendrikse; trade-mark rights are separate from regulatory authorisation. +ICTHendrikse (KvK 73774693) administers rights in original material it created or lawfully acquired. Earlier references to Calorie Token VOF (KvK 84216352) are historical and do not prove transfer of every right. CalorieToken is identified by the project owner as an EU trade mark of Pieter Hendrikse; trade-mark rights are separate from regulatory authorisation. Current versions grant no new general licence. Earlier copies may retain rights validly granted under their historical licence. See [LICENSE](LICENSE), [COPYRIGHT.md](COPYRIGHT.md), [NOTICE](NOTICE) and [trade-mark guidance](docs/TRADEMARK.md). Existing third-party rights and mandatory legal protections remain unaffected. The prototype is experimental and may fail or lose data. Nothing here is financial, investment, medical, dietary, tax or legal advice. Do not put credentials, wallet recovery information or personal data into public issues. Start with the documentation; use the project's published security or privacy contact for a concern that requires it. Documentation reviewed: **10 September 2026**. This revision changes public interpretation and navigation, not executable code, licences, historical test results or deployment. + +The archived README preserves its original bytes, including links written relative to the repository root. Those links may not resolve from `docs/archive/`; use the [original README at its historical commit](https://github.com/CalorieToken/CalorieAppTestnet/blob/cfc230d7e2b92322997fbbc8815be563740c3288/README.md) when following its original links. diff --git a/docs/README.md b/docs/README.md index dd8c9a5..4c68197 100644 --- a/docs/README.md +++ b/docs/README.md @@ -39,3 +39,5 @@ The `archive/` directory contains historical completion reports and development For the current webapp, use [CalorieApp V2](https://github.com/CalorieToken/CalorieApp). [Earlier README](archive/README-before-2026-09-10.md) preserves the dated feature and test statements without claiming they were rerun in this update. + +The archived README preserves its original bytes, including links written relative to the repository root. Those links may not resolve from `docs/archive/`; use the [original README at its historical commit](https://github.com/CalorieToken/CalorieAppTestnet/blob/cfc230d7e2b92322997fbbc8815be563740c3288/README.md) when following its original links.