diff --git a/README.md b/README.md index 83b1cc9..352e8ea 100755 --- a/README.md +++ b/README.md @@ -1,16 +1,72 @@ -# myapp +# GuardianCare -A new Flutter project. +GuardianCare is a child safety app built with Flutter that aims to educate and empower users to protect children from harm. -## Getting Started +## Key Features -This project is a starting point for a Flutter application. +- Educational videos - Topics include preventing child abuse, internet safety guidelines, health tips, etc. +- Interactive quizzes - Test your child safety knowledge with quizzes on important topics. +- Laws forum - Browse, discuss, and share child welfare laws and policies. +- Emergency contacts - Quick access to critical hotlines and services. +- Incident reporting - File reports on child safety issues to authorities. -A few resources to get you started if this is your first Flutter project: +## Screens -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +The app includes the following screens: + +- **Home** - Watch videos on child safety topics. +- **Quiz** - Take educational quizzes and test your knowledge. +- **Forum** - Read about child safety laws and regulations. +- **Emergency** - Direct hotlines for critical situations. +- **Report** - File incident reports on issues affecting child welfare. +- **Account** - Manage profile and app settings. + +## Requirements + +- Flutter 2+ +- Dart 2.12+ + +## Packages + +GuardianCare utilizes the following packages: + +- carousel_slider: ^4.0.0 +- curved_navigation_bar: ^1.0.3 +- firebase_auth: ^3.3.19 +- flutter_webview_plugin: ^0.4.0 +- shared_preferences: ^2.0.15 + +## Installation + +**Step 1:** + +Download or clone this repo by using the link below: + +``` +https://github.com/myusername/guardiancare.git +``` + +**Step 2:** + +Go to project root and execute the following command in console to get the required dependencies: + +``` +flutter pub get +``` + +**Step 3:** + +Run the app with the following command: + +``` +flutter run +``` + +## Contributions + +Contributions are welcome! Please check issues or feel free to propose any feature requests. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference.