Skip to content

Build4Build/snap-read

Repository files navigation

SnapRead - AI-Powered Document Scanner & Summarizer

SnapRead is a powerful mobile app that helps you read and understand documents faster using AI technology. Simply scan any text, and get instant summaries, key points, and important quotes.

Features

  • πŸ“± Smart document scanning with AI-powered text recognition
  • πŸ€– Instant summaries and key points extraction
  • πŸ“š Reading history and organization
  • πŸ“Š Reading analytics and progress tracking
  • πŸ”’ Privacy-first approach with on-device processing

Getting Started

Prerequisites

  • Node.js (v14 or later)
  • npm or yarn
  • Expo CLI
  • iOS Simulator (for Mac) or Android Studio (for Android development)

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/snap-read.git
cd snap-read
  1. Install dependencies:
npm install
# or
yarn install
  1. Start the development server:
npm start
# or
yarn start
  1. Run on your device or simulator:
  • Press i for iOS simulator
  • Press a for Android emulator
  • Scan the QR code with Expo Go app on your physical device

Development

Project Structure

snap-read/
β”œβ”€β”€ assets/           # Images, fonts, and other static files
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/  # Reusable UI components
β”‚   β”œβ”€β”€ screens/     # App screens
β”‚   β”œβ”€β”€ navigation/  # Navigation configuration
β”‚   β”œβ”€β”€ context/     # React Context providers
β”‚   β”œβ”€β”€ hooks/       # Custom React hooks
β”‚   β”œβ”€β”€ services/    # API and business logic
β”‚   └── utils/       # Helper functions
β”œβ”€β”€ scripts/         # Build and utility scripts
└── app.json         # Expo configuration

Available Scripts

  • npm start - Start the Expo development server
  • npm run android - Run on Android
  • npm run ios - Run on iOS
  • npm run web - Run on web
  • npm run generate-icons - Generate app icons
  • npm run generate-screenshots - Generate app store screenshots

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Who Built This SnapRead Mobile App?

Pierre-Henry Soria β€” a super passionate engineer who loves automating content creation efficiently! Enthusiast of YouTube, AI, learning, andβ€”of courseβ€”writing! Find me at pH7.me

Enjoying this project? Buy me a coffee (spoiler: I love almond extra-hot flat white coffees).

Pierre-Henry Soria

@phenrysay YouTube Tech Videos pH-7

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Snap what you read: Take photos of magazines and books, and let the AI learn and summarise them.

Topics

Resources

License

Stars

Watchers

Forks

Contributors