Here's the updated README.md to highlight the bonus features:
KineticQR is a Flutter application that allows users to scan and generate QR codes. It features a clean and intuitive interface with theme toggling for light and dark modes, animations, and security enhancements.
- Scan QR Code: Use the device camera to scan QR codes and display their content.
- Generate QR Code: Input text to generate a QR code that can be shared or saved.
- Dark Mode Support: Switch between light and dark themes for a customizable user experience.
- Animations: Enhanced user experience with smooth animations during scanning and QR code generation.
- Security Notifications: Alerts users if a scanned QR code leads to a potentially harmful website.
- Flutter SDK
- Dart SDK
-
Clone the repository:
git clone https://github.com/khush1yaaar/kineticQR.git cd kineticqr -
Install dependencies:
flutter pub get
-
Configure Android permissions:
- Ensure that
CAMERAandFLASHLIGHTpermissions are set inAndroidManifest.xml.
- Ensure that
-
Run the app:
flutter run
main.dart: Entry point of the application.lib/screens/: Contains the main screens of the app:scan_qr_code.dart: Screen for scanning QR codes with security notifications.generate_qr_code.dart: Screen for generating QR codes with animations.generated_qr.dart: Screen displaying the generated QR code.
lib/theme/: Contains theme-related files for managing light and dark modes.pubspec.yaml: Manages dependencies and project metadata.
scan_qr_code.dart: Contains logic for scanning QR codes, handling detected barcodes, and notifying users of potentially harmful websites.generate_qr_code.dart: Handles text input, generates QR codes, and includes animations for improved user experience.generated_qr.dart: Displays the generated QR code with styling and alignment.
Feel free to submit issues or pull requests. For detailed contribution guidelines, please refer to the project's CONTRIBUTING.md file.
This project is licensed under the MIT License.