Skip to content

Commit bb831b2

Browse files
author
CalorieApp Maintainer
committed
chore: repository cleanup - remove unfinished Universal App Builder scaffold and dev artifacts\n\nRemoved:\n- universal_app_builder/ (docs + scaffold)\n- local wallet/test/log artifacts (untracked)\n\nUpdated .gitignore:\n- Add wallet_state.json\n- Add universal_app_builder/ to keep workspace private\n\nFocus: retain only finished CalorieApp code and essential public documentation.
1 parent 0b0ce21 commit bb831b2

File tree

11 files changed

+557
-237
lines changed

11 files changed

+557
-237
lines changed

‎REPO_CLEANUP_PLAN.md‎

Lines changed: 274 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,274 @@
1+
# Repository Cleanup Plan - CalorieAppTestnet Main Branch
2+
3+
## Executive Summary
4+
5+
The main branch currently contains **Universal App Builder** development material that should be **removed from public GitHub**. Only the finished CalorieApp code and essential documentation should remain public.
6+
7+
## Current Issues
8+
9+
1. **Universal App Builder directory is public** (`universal_app_builder/`)
10+
- Contains incomplete development work
11+
- Includes test projects, temporary workspaces, automation scripts
12+
- Should remain private until finished
13+
14+
2. **Development/test artifacts are public**:
15+
- Test logs (`ux_tour_phase1_*.log`)
16+
- Python cache (`__pycache__/`)
17+
- Coverage files (`.coverage`)
18+
- Local wallet data files
19+
20+
3. **Excessive documentation** for public consumption:
21+
- Many internal development checkpoint files
22+
- Detailed development progress documents
23+
- Technical implementation details meant for development
24+
25+
## Recommended Actions
26+
27+
### 🗑️ Files/Directories to DELETE from main branch
28+
29+
#### 1. Universal App Builder (Entire Directory)
30+
```
31+
universal_app_builder/ # DELETE - All unfinished work
32+
```
33+
34+
#### 2. Test/Development Artifacts
35+
```
36+
ux_tour_phase1_20251119_070640.log # DELETE
37+
ux_tour_phase1_20251119_070729.log # DELETE
38+
.coverage # DELETE (already in .gitignore)
39+
__pycache__/ # DELETE (already in .gitignore)
40+
wallet_data.bak # DELETE (user data)
41+
wallet_data.dat # DELETE (user data)
42+
wallet_data.dir # DELETE (user data)
43+
wallet_state.json # DELETE (user data)
44+
```
45+
46+
#### 3. Development Documentation (Internal Progress Tracking)
47+
```
48+
docs/development-progress/ # DELETE - Internal checkpoints
49+
DEVELOPMENT_CHECKPOINT.md # DELETE (if exists)
50+
FINAL_PROJECT_STATUS.md # DELETE (if exists)
51+
FINAL_SUMMARY.md # DELETE (if exists)
52+
FRESH_USER_TEST_SUCCESS.md # DELETE (if exists)
53+
MNEMONIC_FEATURE_COMPLETE.md # DELETE (if exists)
54+
MNEMONIC_SCREENS_COMPLETE.md # DELETE (if exists)
55+
PROJECT_ORGANIZATION.md # DELETE (if exists)
56+
REORGANIZATION_COMPLETE.md # DELETE (if exists)
57+
COMMIT_QUICK_REFERENCE.md # DELETE - Internal dev reference
58+
COMPREHENSIVE_TODO_LIST.md # DELETE - Internal planning
59+
GIT_COMMIT_GUIDE.md # DELETE - Internal process
60+
```
61+
62+
#### 4. Internal Test Files (Keep in private repo only)
63+
```
64+
test_calorie_linking.py # DELETE - Internal test
65+
test_keypair_import_screen.py # DELETE - Internal test
66+
test_fresh_user_mnemonic.py # DELETE (if exists)
67+
test_mnemonic_app.py # DELETE (if exists)
68+
test_mnemonic_standalone.py # DELETE (if exists)
69+
demo_mnemonic_improvements.py # DELETE (if exists)
70+
```
71+
72+
### ✅ Files/Directories to KEEP (Public-Facing)
73+
74+
#### Essential Application Files
75+
```
76+
main.py # Core app
77+
run.py # Run script
78+
setup.py # Package setup
79+
buildozer.spec # Build config
80+
requirements.txt # Dependencies
81+
requirements.in # Dependency sources
82+
pyproject.toml # Project config
83+
LICENSE # License
84+
```
85+
86+
#### Source Code (Finished Features)
87+
```
88+
src/ # All finished CalorieApp source code
89+
├── core/ # App core
90+
├── screens/ # All screens
91+
├── utils/ # Utilities
92+
└── VERSION.py # Version info
93+
```
94+
95+
#### Essential Resources
96+
```
97+
assets/ # App assets (images, etc.)
98+
config/ # Configuration files
99+
data/ # App data structures
100+
scripts/ # Public utility scripts (run.py, etc.)
101+
```
102+
103+
#### Public-Safe Documentation ONLY
104+
```
105+
README.md # Main readme
106+
docs/
107+
├── CHANGELOG.md # Version history
108+
├── CONTRIBUTING.md # Contribution guide
109+
├── TODO.md # Public roadmap
110+
├── QUICK_START.md # Getting started
111+
├── TRADEMARK.md # Trademark info
112+
├── UX_TOUR_GUIDE.md # Public tour overview
113+
├── TOKEN_SYSTEM_GUIDE.md # Token usage
114+
├── TRANSACTION_DISPLAY_GUIDE.md # Transaction UI
115+
├── FAUCET_TROUBLESHOOTING.md # Faucet help
116+
├── LEGAL_DISCLAIMER.md # Legal info (if exists)
117+
└── OFFICIAL_PROJECT_DOCS.md # Doc index
118+
```
119+
120+
#### CI/CD & Quality
121+
```
122+
.github/ # GitHub Actions workflows (CI/CD)
123+
.gitignore # Git ignore rules
124+
.editorconfig # Editor config
125+
.pre-commit-config.yaml # Pre-commit hooks
126+
tests/ # PUBLIC unit tests only (not internal dev tests)
127+
```
128+
129+
#### Marketing/Release Materials
130+
```
131+
CHANGELOG.md # KEEP
132+
RELEASE_STRATEGY_SUMMARY.md # KEEP
133+
SOCIAL_MEDIA_ANNOUNCEMENT_KIT.md # KEEP
134+
```
135+
136+
### 📝 Documentation to Simplify/Consolidate
137+
138+
Some docs contain too much internal detail. Consider:
139+
140+
1. **UX Tour docs** - Keep high-level guide, remove implementation details
141+
2. **Development progress docs** - Merge relevant info into CHANGELOG, delete originals
142+
3. **Internal guides** - Move to private notes or delete
143+
144+
## Implementation Steps
145+
146+
### Option 1: Clean Main Branch Directly (Recommended)
147+
148+
```powershell
149+
# 1. Switch to main branch
150+
git checkout main
151+
152+
# 2. Remove Universal App Builder completely
153+
git rm -rf universal_app_builder/
154+
155+
# 3. Remove development artifacts
156+
git rm ux_tour_phase1_*.log
157+
git rm test_calorie_linking.py test_keypair_import_screen.py
158+
git rm wallet_data.* wallet_state.json
159+
160+
# 4. Remove internal documentation
161+
git rm COMMIT_QUICK_REFERENCE.md
162+
git rm COMPREHENSIVE_TODO_LIST.md
163+
git rm GIT_COMMIT_GUIDE.md
164+
git rm -rf docs/development-progress/
165+
166+
# 5. Update .gitignore to prevent re-adding
167+
# Add patterns for:
168+
# - *.log (test logs)
169+
# - wallet_data.* (local wallet files)
170+
# - wallet_state.json
171+
# - __pycache__/
172+
# - .coverage
173+
174+
# 6. Commit the cleanup
175+
git commit -m "chore: clean repository - remove development artifacts and unfinished Universal App Builder
176+
177+
- Remove universal_app_builder/ directory (development work, not ready for public)
178+
- Remove internal development documentation and progress tracking
179+
- Remove test artifacts and logs
180+
- Remove local wallet data files
181+
- Update .gitignore to prevent re-adding sensitive files
182+
183+
This cleanup ensures only finished CalorieApp code and essential documentation
184+
remain public, while development work stays private until ready for release."
185+
186+
# 7. Force push to GitHub (THIS REWRITES HISTORY)
187+
git push origin main --force-with-lease
188+
```
189+
190+
### Option 2: Create Clean Public Branch
191+
192+
If you want to preserve history:
193+
194+
```powershell
195+
# 1. Create new clean branch from main
196+
git checkout main
197+
git checkout -b public-release
198+
199+
# 2. Remove unwanted files (same as Option 1 steps 2-5)
200+
# ... (same removal commands)
201+
202+
# 3. Commit
203+
git commit -m "chore: prepare public release branch - remove internal development"
204+
205+
# 4. Push new branch
206+
git push origin public-release
207+
208+
# 5. Update default branch on GitHub to public-release
209+
# Then delete old main branch and rename public-release to main
210+
```
211+
212+
## Risk Assessment
213+
214+
### Low Risk (Safe to Delete)
215+
- `universal_app_builder/` - Exists on feature branch
216+
- Test logs - Reproducible
217+
- Cache files - Automatically regenerated
218+
- Internal docs - Preserved in feature branch
219+
220+
### Medium Risk (Verify First)
221+
- Test files in root - Check if needed for CI
222+
- Some docs - May be referenced elsewhere
223+
224+
### High Risk (DO NOT DELETE)
225+
- `src/` directory - Core application
226+
- `README.md` - Primary documentation
227+
- `LICENSE` - Legal requirement
228+
- `.github/` - CI/CD
229+
230+
## Post-Cleanup Verification
231+
232+
After cleanup, main branch should contain:
233+
234+
1. ✅ Only **CalorieApp** source code
235+
2. ✅ Essential **public documentation**
236+
3. ✅ **Build/deployment** configs
237+
4. ✅ **CI/CD** workflows
238+
5. ✅ **License** and legal files
239+
6. ✅ **Public assets** only
240+
241+
7. ❌ NO **Universal App Builder** code
242+
8. ❌ NO **internal development** docs
243+
9. ❌ NO **test artifacts** or logs
244+
10. ❌ NO **user data** files
245+
246+
## GitHub Settings Recommendations
247+
248+
After cleanup, configure repository:
249+
250+
1. **Branch Protection** for main:
251+
- Require pull request reviews
252+
- Require status checks
253+
- Prevent force pushes (after initial cleanup)
254+
255+
2. **Secrets Management**:
256+
- Ensure no API keys in code
257+
- Use GitHub Secrets for CI/CD
258+
259+
3. **Collaborator Access**:
260+
- Review who has write access
261+
- Use teams for organization
262+
263+
## Summary
264+
265+
**Total files/directories to remove: ~50+**
266+
- 1 major directory (`universal_app_builder/`)
267+
- Multiple development documentation files
268+
- Test artifacts and logs
269+
- Local wallet data
270+
271+
**Remaining: Clean, professional public repository**
272+
- Focused on finished CalorieApp
273+
- Essential documentation only
274+
- Ready for public consumption

‎docs/PHASE1_AUTOMATED_REPORT.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Phase 1 Automated Diagnostics Report
2+
3+
Generated Aggregate: 2025-11-20T22:41:25.886645Z
4+
5+
6+
7+
This report aggregates automated scripts output. Manual visual audit still required.
8+
9+
### Contrast Audit
10+
Generated: 2025-11-20T22:41:07.739632Z
11+
12+
| Case | Ratio | AA | AAA |
13+
|------|-------|----|-----|
14+
| button_text | 8.25 | PASS | PASS |
15+
| button_vs_bg | 7.53 | PASS | PASS |
16+
| primary_label | 19.17 | PASS | PASS |
17+
| secondary_label | 13.45 | PASS | PASS |
18+
19+
### Workflow Diagnostics
20+
Generated: 2025-11-20T22:24:17.710013Z
21+
22+
| Template | Time (s) | Missing Files | Placeholder Artifacts |
23+
|----------|----------|---------------|-----------------------|
24+
| blank_kivy | 0.033 | - | 0 |
25+
| crypto_wallet | 0.093 | - | 0 |
26+
| material_kivymd | 0.026 | - | 0 |
27+
28+
### Export Validation
29+
Generated: 2025-11-20T22:24:32.191461Z
30+
31+
Project Path: C:\Users\P\MyProjects\CalorieAppTestnet\universal_app_builder\automation\temp_export_workspace\export_diag
32+
Zip Path: C:\Users\P\MyProjects\CalorieAppTestnet\universal_app_builder\automation\temp_export_workspace\export_diag.zip
33+
34+
| Metric | Value |
35+
|--------|-------|
36+
| File Count | 9 |
37+
| Venv Entries | 0 |
38+
| Binary Entries | 0 |
39+
40+
### Functional Smoke Tests
41+
Generated: 1763677188.6715949
42+
43+
| Template | Status | Create (s) | Export (s) | Zip Exists |
44+
|----------|--------|------------|------------|------------|
45+
| blank_kivy | ok | 0.038 | 0.202 | True |
46+
| crypto_wallet | ok | 0.031 | 0.071 | True |
47+
| material_kivymd | ok | 0.042 | 0.072 | True |
48+
49+
### Performance Profiler
50+
Generated: 1763677387.2631054
51+
52+
**Summary:**
53+
54+
- Avg create time: 0.0336s
55+
- Avg export time: 0.1553s
56+
- Total files: 27
57+
- Total size: 45.42 KB
58+
- Success rate: 3/3
59+
60+
| Template | Create (s) | Export (s) | Files | Size (KB) |
61+
|----------|------------|------------|-------|-----------|
62+
| blank_kivy | 0.025 | 0.2248 | 8 | 15.91 |
63+
| crypto_wallet | 0.0354 | 0.0914 | 11 | 18.29 |
64+
| material_kivymd | 0.0403 | 0.1498 | 8 | 11.22 |
65+
66+
### GUI Event Simulation
67+
68+
**Summary:**
69+
70+
- Total tests: 6
71+
- Passed: 5
72+
- Failed: 1
73+
74+
| Test | Status | Error |
75+
|------|--------|-------|
76+
| show_template_selector | ok | - |
77+
| show_about | ok | - |
78+
| show_info | ok | - |
79+
| show_error | ok | - |
80+
| show_success | ok | - |
81+
| load_projects | skipped | - |
82+
83+
### Appearance Inventory
84+
85+
**Colors:**
86+
87+
- `text_color`: 1,1,1,1
88+
- `md_bg_color`: 0.06,0.06,0.06,1
89+
90+
**Spacing (dp):**
91+
- `padding_dp`: [20]
92+
- `spacing_dp`: [10, 15]
93+
94+
**Button Styles:** `filled`
95+
96+
**Recommendations:**
97+
- button_bg_color currently [0.2, 0.4, 0.8, 1] (blue)
98+
- button_text_color currently [1, 1, 1, 1] (white)
99+
- Contrast audit shows button_text ratio=4.63 (AA pass), button_vs_bg ratio=4.14 (AA fail)
100+
- Recommended: increase button_bg lightness or button_text brightness for AAA compliance
101+
- Primary labels: high contrast (19.17), secondary labels: good contrast (13.45)
102+
- Spacing values range from 10-20 dp; consistent but could benefit from design system tokens
103+
- Font usage: bold flags used, theme_text_color 'Custom' with explicit RGBA
104+
- Button styles: 'filled' used; consider adding 'outlined' or 'text' variants for hierarchy

0 commit comments

Comments
 (0)