Skip to content

Victor-Zarzar/pdf-reader

Repository files navigation

PDF Reader App - Flutter Multi-Platform Application

Dart Flutter Material Design 3

A multi-platform PDF reader application built with Flutter. Features responsive UI, multi-language support, and seamless PDF viewing experience.


Tech Stack

Core Technologies

  • Dart - Programming language
  • Flutter - Cross-platform UI framework
  • Material Design 3 - Modern design system
  • Provider - State management solution

Features & Integrations

  • Multi-Platform Support - Android, iOS
  • Google Fonts - Beautiful typography
  • i18n - Multi-language support (EN / PT-BR / ES)
  • Flutter PDF Viewer - PDF rendering and display
  • Flutter Local Notifications - Push notifications
  • URL Launcher - External link handling
  • Timezone Initialization - Time zone support

Prerequisites

Before starting, ensure you have the following installed:

Optional: Zed Editor or VS Code with Flutter plugins for IDE support.


Installation & Setup

1. Clone the Repository

git clone https://github.com/Victor-Zarzar/pdf-reader
cd pdf-reader

2. Open in your editor (Zed Editor)

zed .

3. Install Dependencies

flutter pub get

Usage

Local Development

Mobile (iOS Simulator)

Run on iPhone simulator:

flutter run -d "iPhone 17 Pro"

Mobile (Android Emulator)

Run on Android emulator:

flutter run -d android

Development

Code Analysis

Check for code issues:

flutter analyze

Testing

Run all tests:

flutter test

Format Code

Format all files:

dart format .

Project Structure

pdf-reader/
├── lib/                     # Application source code
│   ├── controller/          # Business logic controllers
│   │   └── entity/          # Entity controllers
│   ├── features/            # App features
│   ├── services/            # Services layer
│   └── view/                # UI layer
│       └── widget/          # Reusable widgets
├── assets/                  # Static assets
│   └── imgs/                # Images and mockups
├── android/                 # Android platform code
├── ios/                     # iOS platform code
├── test/                    # Unit and widget tests
├── pubspec.yaml             # Flutter dependencies
└── README.md                # Project documentation

Screenshots

Project Mockup

mockup


Deployment

Android (Google Play Store)

Build production APK:

flutter build apk --release

The generated file will be at: build/app/outputs/flutter-apk/app-release.apk

Build production AppBundle:

flutter build appbundle --release

The generated file will be at: build/app/outputs/bundle/release/app-release.aab

iOS (App Store)

Build production iOS app:

flutter build ios --release

The generated file will be at: build/ios/iphoneos/


Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

License

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


Contact

Victor Zarzar - @Victor-Zarzar

Project Link: https://github.com/Victor-Zarzar/pdf-reader


Made with ❤️ by Victor Zarzar

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published