3.3 KiB
3.3 KiB
Quick Start Guide - Pottery Diary
🚀 Get Running in 2 Minutes
Step 1: Start the Development Server
cd pottery-diary
npm start
Wait for QR code to appear in terminal.
Step 2: Run on Simulator/Emulator
iOS (Mac only):
# In another terminal
npm run ios
Android:
# Make sure Android emulator is running, then:
npm run android
Physical Device:
- Install "Expo Go" app from App Store / Play Store
- Scan the QR code from the terminal
Step 3: Test the App
- Onboarding: Swipe through 3 welcome screens, tap "Get Started"
- Create Project:
- Tap "New Project"
- Enter title: "Test Bowl"
- Add tags: "bowl, cone 6"
- Tap "Create Project"
- 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"
- Add Glaze Step:
- Tap "Add Step"
- Select "Glazing"
- Enter 2 coats
- Tap "Save Step"
- Add Glaze Firing Step:
- Tap "Add Step"
- Select "Glaze Firing"
- Enter Cone: "6" (temp auto-fills to 2232°F)
- Tap "Save Step"
- View Timeline: See all steps in order
- 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
npm test
Expected output: All tests pass (11 tests across 3 suites)
📱 Test on Physical Device
Option 1: Expo Go (Quick)
- Install Expo Go app
- Scan QR code from
npm start - App loads in Expo Go container
Option 2: Development Build (Full Features)
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'"
npx expo install expo-sqlite
npm start --clear
"Metro bundler error"
npm start --clear
TypeScript errors
npx tsc --noEmit
Tests failing
npm test -- --clearCache
npm test
Database not seeding
- Delete app from simulator/device
- Reinstall (database auto-seeds on first launch)
🎬 Next Steps
- ✅ Verify app runs and tests pass
- 📸 Add photo capture UI (expo-camera already configured)
- 🔍 Build glaze picker screen
- 📤 Implement data export
- 🌐 Add news feed JSON fetching
- 🎨 Design app icon
- 📱 Build with EAS (
eas build --platform all) - 🚀 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?
- Check terminal for errors
- Run
npm start --clearto clear cache - Delete app and reinstall
- Check
node_modulesfolder exists (runnpm installif not) - Verify Node.js 18+ is installed (
node --version)
Ready? Run npm start and start building! 🏺