# Quick Start Guide - Pottery Diary ## ๐Ÿš€ Get Running in 2 Minutes ### Step 1: Start the Development Server ```bash cd pottery-diary npm start ``` Wait for QR code to appear in terminal. ### Step 2: Run on Simulator/Emulator **iOS (Mac only)**: ```bash # In another terminal npm run ios ``` **Android**: ```bash # Make sure Android emulator is running, then: npm run android ``` **Physical Device**: 1. Install "Expo Go" app from App Store / Play Store 2. Scan the QR code from the terminal ### Step 3: Test the App 1. **Onboarding**: Swipe through 3 welcome screens, tap "Get Started" 2. **Create Project**: - Tap "New Project" - Enter title: "Test Bowl" - Add tags: "bowl, cone 6" - Tap "Create Project" 3. **Add Bisque Step**: - Tap "Add Step" - Select "Bisque Firing" - Enter Cone: "04" (temp auto-fills to 1945ยฐF) - Add notes: "Slow ramp" - Tap "Save Step" 4. **Add Glaze Step**: - Tap "Add Step" - Select "Glazing" - Enter 2 coats - Tap "Save Step" 5. **Add Glaze Firing Step**: - Tap "Add Step" - Select "Glaze Firing" - Enter Cone: "6" (temp auto-fills to 2232ยฐF) - Tap "Save Step" 6. **View Timeline**: See all steps in order 7. **Test Settings**: - Go to Settings tab - Toggle Temperature Unit to ยฐC - Go back to project - Verify temps converted (1945ยฐF โ†’ 1063ยฐC, 2232ยฐF โ†’ 1222ยฐC) ## โœ… Expected Behavior - Projects list shows "Test Bowl" with "In Progress" status - Project detail shows 3 steps with icons (๐Ÿ”ฅ, ๐ŸŽจ, โšก) - Cone numbers auto-fill temperatures - Unit conversions work instantly - All data persists after app restart ## ๐Ÿงช Run Tests ```bash npm test ``` Expected output: **All tests pass** (11 tests across 3 suites) ## ๐Ÿ“ฑ Test on Physical Device ### Option 1: Expo Go (Quick) 1. Install Expo Go app 2. Scan QR code from `npm start` 3. App loads in Expo Go container ### Option 2: Development Build (Full Features) ```bash npm install -g eas-cli eas login eas build --profile development --platform ios # or eas build --profile development --platform android ``` ## ๐Ÿ› Troubleshooting ### "Cannot find module 'expo-sqlite'" ```bash npx expo install expo-sqlite npm start --clear ``` ### "Metro bundler error" ```bash npm start --clear ``` ### TypeScript errors ```bash npx tsc --noEmit ``` ### Tests failing ```bash npm test -- --clearCache npm test ``` ### Database not seeding - Delete app from simulator/device - Reinstall (database auto-seeds on first launch) ## ๐ŸŽฌ Next Steps 1. โœ… Verify app runs and tests pass 2. ๐Ÿ“ธ Add photo capture UI (expo-camera already configured) 3. ๐Ÿ” Build glaze picker screen 4. ๐Ÿ“ค Implement data export 5. ๐ŸŒ Add news feed JSON fetching 6. ๐ŸŽจ Design app icon 7. ๐Ÿ“ฑ Build with EAS (`eas build --platform all`) 8. ๐Ÿš€ Submit to App Store / Play Store ## ๐Ÿ“š Documentation - **README.md**: Full setup and features - **PROJECT_SUMMARY.md**: Implementation details - **BUILD_INSTRUCTIONS.md**: Deployment guide - **docs/PRD.md**: Product requirements - **SECURITY.md**: Privacy and security - **PRIVACY.md**: CCPA compliance ## ๐Ÿ†˜ Need Help? 1. Check terminal for errors 2. Run `npm start --clear` to clear cache 3. Delete app and reinstall 4. Check `node_modules` folder exists (run `npm install` if not) 5. Verify Node.js 18+ is installed (`node --version`) --- **Ready?** Run `npm start` and start building! ๐Ÿบ