RTSDA/RTSDA-Website
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Remove unnecessary documentation files

Browse source
This commit is contained in:
Benjamin Slingo 2025-08-30 09:02:19 -04:00
parent 80020d96a4
commit 6909cef217
4 changed files with 0 additions and 464 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
CHANGES.md
View file

@ -1,104 +0,0 @@
# Admin Panel Architecture Conversion & Cleanup
## Summary
Converted the 1800+ line vanilla JavaScript admin panel to proper Astro routes following CLAUDE.md architecture rules. Removed thumbnail field from event submission form as requested.
## Files Changed
### ✅ REMOVED (Architecture Violations)
- `astro-church-website/public/admin/scripts/main.js` - 1843 lines of vanilla JS making direct API calls
- `astro-church-website/public/admin/` - Entire directory removed
### ✅ ADDED (Proper Architecture)
**New Admin Routes (Astro + TypeScript):**
- `astro-church-website/src/pages/admin/events.astro` - Events management UI
- `astro-church-website/src/pages/admin/bulletins.astro` - Bulletins management UI
- `astro-church-website/src/pages/admin/api/events.ts` - Events API endpoints
- `astro-church-website/src/pages/admin/api/events/[id].ts` - Event CRUD operations
- `astro-church-website/src/pages/admin/api/events/[id]/approve.ts` - Event approval
- `astro-church-website/src/pages/admin/api/events/[id]/reject.ts` - Event rejection
- `astro-church-website/src/pages/admin/api/bulletins.ts` - Bulletins API endpoints
- `astro-church-website/src/pages/admin/api/bulletins/[id].ts` - Bulletin CRUD operations
- `astro-church-website/src/pages/admin/api/auth/login.ts` - Admin authentication
### ✅ ENHANCED (Rust Core Functions)
**church-core/src/api.rs** - Added missing admin functions:
- Auth: `admin_login_json()`, `validate_admin_token_json()`
- Events: `fetch_pending_events_json()`, `approve_pending_event_json()`, `reject_pending_event_json()`, `delete_pending_event_json()`, `create_admin_event_json()`, `update_admin_event_json()`, `delete_admin_event_json()`
- Bulletins: `create_bulletin_json()`, `update_bulletin_json()`, `delete_bulletin_json()`
**church-core/src/client/mod.rs** - Added auth methods:
- `admin_login()` - Handles admin authentication
- `validate_admin_token()` - Validates admin session tokens
### ✅ UPDATED (Bindings & Config)
**astro-church-website/src/lib/bindings.js** - Added exports for new admin functions
**astro-church-website/DEPLOYMENT.md** - Updated deployment instructions
### ✅ THUMBNAIL FIELD REMOVAL
**astro-church-website/src/pages/events/submit.astro** - Removed:
- Thumbnail upload section (HTML form elements)
- Thumbnail JavaScript handling code
- Thumbnail file processing in form submission
## Architecture Compliance Achieved
### ✅ BEFORE (Violations)
```
Frontend → fetch() → External API directly
```
### ✅ AFTER (Correct)
```
Frontend (Astro) → bindings.js → Rust FFI → church-core → API
```
## Results
- **Removed 1843 lines** of architecture-violating vanilla JavaScript
- **Added proper TypeScript Astro routes** following the architecture
- **All admin functionality** now goes through the Rust core
- **Build verified** - project compiles and runs successfully
- **Bundle size reduced** - cleaner, more efficient code
## Next Steps Required
### 🔄 Additional Architecture Violations to Fix
1. **Event Submission Still Direct API** (`src/pages/events/submit.astro:748`)
- Currently: `fetch('https://api.rockvilletollandsda.church/api/events/submit')`
- Should: Use `submitEventJson()` from bindings
2. **Missing Admin Functions in Rust Core**
- Admin stats/dashboard data
- Configuration management (recurring types)
- User management functions
3. **Data Model Mismatches** (from CLAUDE.md)
- Frontend expects Schedule fields: `song_leader`, `childrens_story`
- Check if Rust Schedule model has these fields
4. **Upload Functionality**
- Current admin JS had image upload logic
- Need to implement via Rust upload functions
### 🧹 Code Cleanup Opportunities
1. **Dead Code in Rust** (warnings from build)
- `church-core/src/models/streaming.rs:1` - unused Serialize/Deserialize
- `church-core/src/utils/formatting.rs:56` - unused FixedOffset
- `church-core/src/client/http.rs:197` - unused delete method
2. **Validation Enhancement**
- Add proper TypeScript types for admin API responses
- Add client-side validation for admin forms
3. **Error Handling**
- Replace generic `alert()` calls with proper error UI
- Add loading states for admin operations
## Testing Required
- [ ] Admin login functionality
- [ ] Event approval/rejection workflow
- [ ] Bulletin CRUD operations
- [ ] Schedule management (existing)
- [ ] Event submission without thumbnail field

123
CLAUDE.md
View file

@ -1,123 +0,0 @@
# CLAUDE INSTRUCTIONS - RTSDA CODEBASE
## **CRITICAL ARCHITECTURE UNDERSTANDING**
### **ASTRO IS A THIN UI LAYER ONLY**
- Astro handles routing, SSR, and basic UI rendering
- **NO BUSINESS LOGIC IN FRONTEND**
- **NO DIRECT API CALLS FROM FRONTEND**
- **ALL LOGIC GOES THROUGH `church-core` RUST CRATE**
### **THE RUST CRATE IS THE CORE FOR A FUCKING REASON**
- `church-core/` contains ALL business logic
- `church-core/` handles ALL API communication
- `church-core/` provides unified data models
- `church-core/` has caching, error handling, auth
- **USE THE RUST CRATE, DON'T BYPASS IT**
## ✅ **FIXED VIOLATIONS**
### **Admin Panel (COMPLETED ✅)**
- ~~`public/admin/scripts/main.js` - 1800+ lines of vanilla JS~~ **REMOVED**
- ✅ **NOW:** Proper Astro routes using Rust functions via FFI bindings
- ✅ **FIXED:** Frontend now follows core architecture
## **REMAINING VIOLATIONS TO FIX**
### **Event Submission Direct API Call**
- `src/pages/events/submit.astro:748` - Still uses direct fetch() call
- **SHOULD BE:** Use `submitEventJson()` from bindings.js
- **VIOLATION:** Bypassing the unified client architecture
### **Data Model Mismatches**
- Frontend expects detailed Schedule fields (`song_leader`, `childrens_story`)
- Backend Rust models missing these fields
- **CAUSE:** Frontend developed independently of core models
## **CORRECT ARCHITECTURE FLOW**
```
Frontend (Astro) → bindings.js → Rust FFI → church-core → API
```
**NOT:**
```
Frontend → fetch() → API directly
```
## **HOW TO FIX VIOLATIONS**
### **For Event Submission:**
1. ✅ Admin functions already exist in `church-core/src/client/admin.rs`
2. ✅ Already exposed via FFI in `church-core/src/api.rs`
3. ✅ Already imported in `astro-church-website/src/lib/bindings.js`
4. **TODO:** Replace `fetch()` call with `submitEventJson()` function
### **For Data Models:**
1. Update Schedule models in `church-core/src/models/admin.rs`
2. Add missing fields (`song_leader`, `childrens_story`, etc.)
3. Regenerate FFI bindings
4. Update frontend to use new model structure
## **COMMANDS TO REMEMBER**
### **Build Commands:**
```bash
# Build Rust bindings FIRST
npm run build:native
# Then build Astro
npm run build
# Dev server
npm run dev
```
### **Testing Commands:**
```bash
# Test Rust core
cd church-core && cargo test
# Test API connectivity
cd church-core && cargo run --bin church-core-test
```
## **BEFORE MAKING CHANGES**
1. **Check if Rust function exists** in `church-core/`
2. **If missing, ADD IT TO RUST FIRST**
3. **Then expose via FFI bindings**
4. **Finally update frontend to use it**
## **DO NOT:**
- Add business logic to JavaScript
- Make direct API calls from frontend
- Create data models in frontend
- Bypass the Rust crate architecture
## **THE RUST CRATE EXISTS FOR:**
- Cross-platform consistency (iOS, Android, Web)
- Type safety and error handling
- Unified caching and auth
- Single source of truth for API communication
**RESPECT THE ARCHITECTURE. USE THE RUST CRATE.**
## **CLEANUP PROGRESS TRACKING**
### ✅ **COMPLETED (Aug 29, 2025)**
- **Admin Panel Conversion**: Removed 1843-line vanilla JS file
- **Proper Astro Routes**: Created TypeScript admin routes using Rust functions
- **Thumbnail Field Removal**: Cleaned up event submission form
- **FFI Functions**: Added 12 new admin functions in church-core
- **Architecture Compliance**: Admin panel now follows correct flow
**Commit:** `f91f696` - Convert admin panel to Astro routes and remove thumbnail field
### 🚨 **HIGH PRIORITY NEXT**
1. Fix event submission direct API call (`src/pages/events/submit.astro:748`)
2. Check Schedule model data field mismatches
3. Add missing admin functions (stats, config, users)
**See:** `/NEXT-STEPS.md` for detailed implementation plan

124
DEPLOYMENT.md
View file

@ -1,124 +0,0 @@
# Deployment Instructions
## Files to Copy to Server
### New/Modified Files:
```
src/pages/admin/index.astro # Main admin dashboard page
src/components/admin/Login.astro # Admin login component
src/pages/bulletin/[id].astro # Fixed bulletin detail page (SSR)
src/pages/admin/ # New Astro admin routes (TypeScript)
```
### Verify these files exist on server:
```
src/pages/admin/ # New admin routes using Rust bindings
```
## Deployment Steps
1. **Copy files to server:**
```bash
# Copy new admin components
scp -r src/pages/admin/ user@server:/opt/rtsda/src/pages/
scp -r src/components/admin/ user@server:/opt/rtsda/src/components/
# Copy fixed bulletin page
scp src/pages/bulletin/[id].astro user@server:/opt/rtsda/src/pages/bulletin/
# Copy new admin API routes
scp -r src/pages/admin/api/ user@server:/opt/rtsda/src/pages/admin/
```
2. **SSH into server:**
```bash
ssh user@server
cd /opt/rtsda
```
3. **Build and restart:**
```bash
npm run build
pm2 restart astro-app
```
## Testing After Deployment
1. **Test bulletin fix:**
- Visit: `https://yourdomain.com/bulletin/5bebfe94-71ca-4a72-b9a8-ecd1195c8182`
- Should show bulletin content, not "bulletin not found"
2. **Test admin dashboard:**
- Visit: `https://yourdomain.com/admin/`
- Should show login screen
- Login with admin credentials
- Verify all sections work: Events, Bulletins, Schedules
## Potential Issues & Solutions
### Build Errors:
```bash
# If node version issues:
node --version # Should be 20.x
npm --version
# If dependency issues:
rm -rf node_modules package-lock.json
npm install
npm run build
```
### Permission Issues:
```bash
# Fix ownership
sudo chown -R $USER:$USER /opt/rtsda
chmod -R 755 /opt/rtsda
# Fix specific file permissions
chmod 644 src/pages/admin/index.astro
chmod 644 src/components/admin/Login.astro
chmod 644 src/pages/bulletin/[id].astro
```
### Admin Route Not Working:
- Check if `/admin/` route is accessible
- Verify admin files were copied correctly
- Check PM2 logs: `pm2 logs astro-app`
### Styles Not Loading:
- Hard refresh browser (Ctrl+F5)
- Check if build completed successfully
- Verify no CSS compilation errors in build output
## Rollback Plan
If something breaks:
```bash
# Quick rollback
git status
git checkout -- src/pages/bulletin/[id].astro
rm -rf src/pages/admin/
rm -rf src/components/admin/
npm run build
pm2 restart astro-app
```
## Success Indicators
✅ Build completes without errors
✅ Bulletin pages show content instead of "not found"
✅ `/admin/` shows login screen
✅ Admin dashboard fully functional after login
✅ Site loads normally for regular visitors
## Notes
- Admin dashboard is completely hidden from public navigation
- Only accessible via direct URL: `/admin/`
- Requires valid JWT authentication
- All original functionality preserved
- Styling matches main site theme
---
*"It should be simple, but it probably won't be." - Murphy's Law of Deployment*

113
NEXT-STEPS.md
View file

@ -1,113 +0,0 @@
# Next Steps for Architecture Cleanup
## 🚨 Priority 1: Critical Architecture Violations
### 1. Fix Event Submission Direct API Call
**Location:** `astro-church-website/src/pages/events/submit.astro:748`
**Issue:** Still uses `fetch('https://api.rockvilletollandsda.church/api/events/submit')`
**Fix:** Replace with `submitEventJson()` function from bindings
### 2. Data Model Mismatches
**Issue:** Frontend expects Schedule fields that may not exist in Rust models
**Check:** Does `church-core/src/models/admin.rs` Schedule struct have:
- `song_leader`
- `childrens_story`
- `ss_teacher`
- `ss_leader`
- `mission_story`
- `special_notes`
**Fix:** Update Rust Schedule model if fields are missing
## 🧹 Priority 2: Code Cleanup
### 1. Remove Dead Code (Rust Warnings)
```bash
# Fix these warnings from build output:
cargo fix --lib -p church-core
```
**Locations:**
- `church-core/src/models/streaming.rs:1` - unused Serialize/Deserialize
- `church-core/src/utils/formatting.rs:56` - unused FixedOffset
- `church-core/src/client/http.rs:197` - unused delete method
### 2. Missing Admin Functions
**Add to `church-core/src/api.rs`:**
- `fetch_admin_stats_json()` - Dashboard statistics
- `fetch_recurring_types_json()` - Configuration data
- `get_admin_users_json()` - User management
### 3. Upload Functionality
**Issue:** Old admin JS had image upload logic not yet converted
**Add to `church-core/src/api.rs`:**
- `upload_event_image_json()`
- `upload_bulletin_cover_json()`
## 🔄 Priority 3: Enhanced Admin Features
### 1. Add TypeScript Types
**Create:** `astro-church-website/src/types/admin.ts`
- Define admin API response types
- Add type safety for admin operations
### 2. Improve Error Handling
**Replace:** Generic `alert()` calls in admin pages
**With:** Proper error UI components
### 3. Add Loading States
**Add to admin pages:**
- Loading spinners for operations
- Disabled states during API calls
- Better UX feedback
## 🎯 Priority 4: Testing & Validation
### 1. Test New Admin Functionality
- [ ] Login/logout flow
- [ ] Event approval/rejection
- [ ] Bulletin CRUD operations
- [ ] Schedule management
- [ ] Event submission without thumbnail
### 2. Add Form Validation
- [ ] Client-side validation for admin forms
- [ ] Real-time feedback
- [ ] Error message display
## 📝 Implementation Order
1. **Immediate (blocking):** Fix event submission API call
2. **High:** Check/fix Schedule model data mismatches
3. **Medium:** Add missing admin functions
4. **Low:** UI/UX improvements and TypeScript types
## 🔧 Commands to Run
```bash
# Test current state
cd astro-church-website
npm run build
npm run dev
# Fix Rust warnings
cd ../church-core
cargo fix --lib -p church-core
# Rebuild after Rust changes
cd ../astro-church-website
npm run build:native
npm run build
```
## 🏆 Architecture Success Metrics
**✅ ACHIEVED:**
- Removed 1843 lines of direct API call violations
- All admin routes now use Rust core functions
- Proper Astro/TypeScript structure implemented
**🎯 TARGET:**
- Zero direct API calls from frontend
- All business logic in Rust crate
- Complete type safety with TypeScript
- Full test coverage for admin operations