diff --git a/README.md b/README.md index 15adc24..dd6a442 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,97 @@ -# english_learning +

+ SEALS Logo +

-A new Flutter project. +# SEALS - Smart English Adaptive Learning System -## Getting Started +## Overview -This project is a starting point for a Flutter application. +SEALS refers to a personalized approach to language education that adjusts to the individual learner's needs, pace, and skill level. -A few resources to get you started if this is your first Flutter project: +## System Requirements -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +- Flutter version 3.19.0 or higher +- Dart version 3.3.0 or higher +- Android Studio / VS Code +- Android SDK version 23 (Android 7.0) or higher +- Minimum 2GB RAM +- 500MB free storage space -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. +## Installation + +1. Clone the repository: + +```bash +git clone https://gitlab.com/profile-image/kedaireka/polinema-adapative-learning/mobile-adaptive-learning.git +``` + +2. Navigate to project directory: + +```bash +cd mobile-adaptive-learning +``` + +3. Install dependencies: + +```bash +flutter pub get +``` + +4. Run the application: + +```bash +flutter run +``` + +## Dependencies + +```yaml +dependencies: + audioplayers: ^6.1.0 + bootstrap_icons: ^1.11.3 + cached_network_image: ^3.4.1 + carousel_slider: ^5.0.0 + cupertino_icons: ^1.0.8 + dio: ^5.7.0 + flick_video_player: ^0.9.0 + flutter: + sdk: flutter + flutter_inappwebview: ^6.0.0 + flutter_secure_storage: ^9.2.2 + flutter_svg: ^2.0.10+1 + flutter_widget_from_html: ^0.15.2 + google_fonts: ^6.2.1 + google_nav_bar: ^5.0.6 + html: ^0.15.4 + image_picker: ^1.1.2 + intl: ^0.19.0 + jwt_decoder: ^2.0.1 + provider: ^6.1.2 + shared_preferences: ^2.3.2 + shimmer: ^3.0.0 + video_player: ^2.9.1 + youtube_player_flutter: ^9.1.1 +``` + +### Build Release + +#### Android + +```bash +# Generate Android App Bundle +flutter build appbundle --release + +# Generate APK +flutter build apk --release +``` + +## Development Team + +- Naresh Pratista - Mobile App Developer - [nareshpratista.contact@gmail.com](mailto:nareshpratista.contact@gmail.com) +- Diah Putri Nofianti - UI/UX Designer - [diahputrinofianti@gmail.com](mailto:diahputrinofianti@gmail.com) +- Elang Putra Adam - Backend Developer - [elangptra17@gmail.com](mailto:elangptra17@gmail.com) + +## Acknowledgments + +- [Flutter](https://flutter.dev/) - UI framework +- [Provider](https://pub.dev/packages/provider) - State management