Tawakkalna - توكلنا

SDK for Flutter

⚠️ Disclaimer: This is an unofficial SDK and is not affiliated with or endorsed by the official Tawakkalna team or the Saudi government. This library is currently maintained by individual contributors as an open-source community project.

🧪 Testing Notice: Most API integrations in this SDK have been tested using the Tawakkalna Developer Test Utility app. While the APIs work correctly in the test environment, developers should verify all functionality in the production Tawakkalna app before releasing their mini apps to ensure complete compatibility and proper data handling.

A comprehensive Flutter SDK for integrating with Tawakkalna, Saudi Arabia's super app that unifies government services in one platform. Tawakkalna organizes services, information, documents, and posts to make them easier to use and improve the quality of life in Saudi Arabia in alignment with Vision 2030 goals.

🇸🇦 About Tawakkalna #

Tawakkalna is the official Saudi Arabian super app that provides citizens, residents, and visitors with:

• Unified Government Services - Access to multiple government services in one place
• Digital Identity - Secure digital ID and document management
• Health Services - COVID-19 status, vaccination records, and health information
• Personal Data - Centralized access to personal, family, and vehicle information
• Document Management - Passports, IDs, licenses, and official documents
• Smart Integration - Seamless connection between government entities

Mini Apps Platform #

Tawakkalna operates as a super app platform that hosts mini applications from various service providers. Developers can create mini apps (HTML/JS implementations) that run exclusively within the Tawakkalna app environment. These mini apps are distributed through Tawakkalna's portal store and have access to user data and services through the platform's JavaScript SDK.

About This SDK #

This Flutter SDK provides a web-to-native bridge that allows Flutter developers to:

• Build mini apps using Flutter Web that compile to HTML/JS
• Access Tawakkalna's JavaScript APIs through Dart interop
• Test and develop with mock data before deploying to the Tawakkalna platform
• Use strongly-typed Dart models instead of raw JavaScript objects

This SDK enables Flutter developers to integrate Tawakkalna's powerful features into their mini applications, providing users with secure, convenient access to their government data and services.

📸 Screenshots #

✨ Features #

Core Capabilities #

• 🔐 Dual API Support - Both V1 (comprehensive) and V2 (modern) APIs
• 👤 User Information - Full name, ID, gender, birth date, nationality, contact details
• 📄 Document Access - Passports, IDs, Iqama, expiry dates, document numbers
• 🏥 Health Data - Blood type, health status, disability information
• 👨‍👩‍👧‍👦 Family & Sponsors - Family members and sponsor details with filtering
• 🚗 Vehicles & Violations - Vehicle information, paid/unpaid traffic violations
• 📍 Location Services - GPS location and national address details
• 🎓 Education & Career - Degree type and occupation information
• 📸 Media Access - Gallery, camera, and file management
• 🔒 Permissions - Location, camera, storage, and notification permissions
• 📱 Device Info - Device capabilities and information
• 🔍 Scanner Integration - QR/Barcode scanning capabilities

Developer Experience #

• 🧪 Mock Implementation - Built-in demo data with realistic JSON fixtures
• 🔒 Type-Safe - Full Dart type safety with strongly-typed models and enums
• 📝 Well Documented - Comprehensive API documentation and examples
• 🎨 Example App - Complete demo with 50+ interactive API examples
• 🪵 Built-in Logger - Debug logging with UI viewer and memory management
• ✅ Tested - Unit tests for all implementations
• 🌐 Web Support - JavaScript interop for web platform

📦 Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  tawakkalna_sdk_flutter: ^0.0.4-alpha.4

Then run:

flutter pub get

Web Platform Setup #

For Flutter Web projects, you must include the appropriate JavaScript bridge file in your web/index.html:

For Development/Testing (Mock Data)

Add this script tag to your web/index.html before the closing </body> tag:

<!-- For development and testing with mock data -->
<script src="assets/packages/tawakkalna_sdk_flutter/assets/web/twkhelper_mock.js"></script>

For Production (Tawakkalna App Deployment)

When deploying your mini app to the Tawakkalna platform, use the production JavaScript file:

<!-- For production deployment to Tawakkalna app -->
<script src="assets/packages/tawakkalna_sdk_flutter/assets/web/twkhelper.js"></script>

Important: Choose the correct JavaScript file based on your environment:

• twkhelper_mock.js - Development/testing with mock data
• twkhelper.js - Production deployment to Tawakkalna app

The SDK will not work on web without the appropriate JavaScript bridge file.

Production Build Optimization: When building for production (flutter build web --release), remove unnecessary JavaScript files and mock data from your build output to reduce bundle size:

# After building, remove the unused mock files
rm -f build/web/assets/packages/tawakkalna_sdk_flutter/assets/web/twkhelper_mock.js
rm -f build/web/assets/assets/mock_profile1.0.2.json

Similarly, if you used mock for development, remove twkhelper.js from development builds to avoid confusion.

🚀 Quick Start #

import 'package:tawakkalna_sdk_flutter/tawakkalna_sdk_flutter.dart';

void main() async {
  // Initialize SDK (uses demo implementation by default for testing)
  final twk = TwkHelper();

  // Get user information
  final fullName = await twk.getUserFullName();
  print('Name: ${fullName.en} / ${fullName.ar}');
  
  final nationality = await twk.getUserNationality();
  print('Nationality: ${nationality.en} (${nationality.isoCode})');

  // Get user ID and details
  final userId = await twk.getUserId();
  final userType = await twk.getUserType();
  final birthDate = await twk.getUserBirthDate();
  print('User: $userId, Type: $userType, Born: $birthDate');
  
  // Family members with filtering
  final adults = await twk.getUserFamilyMembers(
    minAge: 18,
    gender: Gender.male,
  );
  print('Adult male family members: ${adults.length}');
  
  // Vehicle information
  final vehicles = await twk.getUserVehicles();
  print('Registered vehicles: ${vehicles.length}');
}

📱 Example App #

A comprehensive example app demonstrating all SDK capabilities is available in the /example directory with 50+ interactive API examples.

Running the Example #

cd example
flutter run -d chrome  # For web
flutter run            # For mobile/desktop

Example App Features #

• ✅ Complete API Coverage - All V1 (45+ methods) and V2 (5 methods) endpoints
• 🎨 Modern UI - Material Design 3 with organized sections
• 📊 Real-time Results - Live display of API responses with error handling
• 🪵 Integrated Logger - View SDK logs with statistics and filtering
• 📸 Image Preview - Visual gallery for image/file responses
• 🎯 Categorized - Organized into 14 sections:
  • Personal Information (8 methods)
  • Contact & Location (4 methods)
  • Documents & IDs (5 methods)
  • Health Information (4 methods)
  • Education & Career (2 methods)
  • Family & Sponsors (3 methods)
  • Vehicles & Violations (3 methods)
  • Gallery & Camera (6 methods)
  • File Management (2 methods)
  • Permissions (5 methods)
  • Authentication (2 methods)
  • Scanner (1 method)
  • Device Info (1 method)
  • V2 API (5 methods)

See example/EXAMPLE_GUIDE.md for detailed documentation.

📚 API Overview #

Structured Data Models #

The SDK provides strongly-typed models with bilingual support:

final twk = TwkHelper();

// Authentication Token
final token = await twk.generateToken();
print('Token: $token');

// User Full Name (Bilingual)
final fullName = await twk.getUserFullName();
print('English: ${fullName.en}');
print('Arabic: ${fullName.ar}');

// Nationality with ISO Code
final nationality = await twk.getUserNationality();
print('${nationality.en} / ${nationality.ar}');
print('ISO Code: ${nationality.isoCode}');

// Family Members (with optional filtering)
final allFamily = await twk.getUserFamilyMembers();
final femaleMembersOver18 = await twk.getUserFamilyMembers(
  minAge: 18,
  gender: Gender.female,
);
final children = await twk.getUserFamilyMembers(
  maxAge: 17,
);

// Sponsors Information
final sponsors = await twk.getUserSponsors();
for (var sponsor in sponsors) {
  print('Sponsor: ${sponsor.name.en}');
}

User Data Access #

Extensive access to user data across multiple categories:

Personal Information

final twk = TwkHelper();

// Basic Identity
final id = await twk.getUserId();              // National/Iqama ID
final type = await twk.getUserType();          // Citizen/Resident/Visitor
final name = await twk.getUserFullName();      // Full name
final gender = await twk.getUserGender();      // Male/Female
final birthDate = await twk.getUserBirthDate(); // Birth date
final nationality = await twk.getUserNationality(); // Nationality
final nationalityIso = await twk.getUserNationalityIso(); // ISO code

// Personal Details
final maritalStatus = await twk.getUserMaritalStatus();
final bloodType = await twk.getUserBloodType();
final healthStatus = await twk.getUserHealthStatus();
final disabilityType = await twk.getUserDisabilityType();

Contact & Location

// Contact Information
final mobile = await twk.getUserMobileNumber();
final email = await twk.getUserEmail();

// Location Data
final location = await twk.getUserLocation();
print('Lat: ${location.latitude}, Lng: ${location.longitude}');

final addresses = await twk.getUserNationalAddress();
for (var address in addresses) {
  print('${address.buildingNumber}, ${address.street}');
  print('${address.district}, ${address.city} ${address.postalCode}');
}

Documents & IDs

final passportResponse = await twk.getUserPassports();
for (var passport in passportResponse.passports) {
  print('Passport: ${passport.number}');
  print('Expires: ${passport.expiryDate}');
}

final idExpiry = await twk.getUserIdExpiryDate();
final docNumber = await twk.getUserDocumentNumber();
final iqamaType = await twk.getUserIqamaType();

Vehicles & Traffic Violations

// Vehicle Information
final vehicles = await twk.getUserVehicles();
for (var vehicle in vehicles) {
  print('${vehicle.make} ${vehicle.model} - ${vehicle.plateNumber}');
  print('Year: ${vehicle.year}, Color: ${vehicle.color}');
}

// Traffic Violations
final unpaidViolations = await twk.getUserUnPaidViolations();
final paidViolations = await twk.getUserPaidViolations();
print('Unpaid: ${unpaidViolations.length}, Paid: ${paidViolations.length}');

Education & Career

final degree = await twk.getUserDegreeType();
final occupation = await twk.getUserOccupation();

Family & Sponsors

// All family members
final family = await twk.getUserFamilyMembers();

// Filtered queries
final adults = await twk.getUserFamilyMembers(minAge: 18);
final females = await twk.getUserFamilyMembers(gender: Gender.female);
final adultMales = await twk.getUserFamilyMembers(
  minAge: 18,
  gender: Gender.male,
);

// Sponsors with filtering
final sponsors = await twk.getUserSponsors();
final activeSponsors = await twk.getUserSponsors(minAge: 25, maxAge: 65);

Gallery, Camera & Files

// Gallery Access
final singleImage = await twk.getGallerySingle();
final multipleImages = await twk.getGalleryMulti();
final singleVideo = await twk.getGallerySingleVideo();
final multipleVideos = await twk.getGalleryMultiVideo();

// Camera
final photo = await twk.getCameraPhoto();
final video = await twk.getCameraVideo();

// File Management
final fileBase64 = await twk.getFileBase64();
final fileId = await twk.getFileId();

Permissions

// Request Permissions
await twk.askUserLocationPermission();
await twk.askCameraPermission();
await twk.askGalleryPermission();
await twk.askPushNotificationPermission();
await twk.askUserPreciseLocationPermission();

Authentication & Security

final authenticated = await twk.authenticateBiometric();
print('User authenticated: $authenticated');

Scanner & Device

// QR/Barcode Scanner
final scanResult = await twk.scanCode();
print('Scanned: $scanResult');

// Device Information
final deviceInfo = await twk.getDeviceInfo();
print('Platform: ${deviceInfo?.platform}');
print('Version: ${deviceInfo?.version}');

📊 Data Models & Enums #

The SDK provides strongly-typed Dart models for all data structures:

Core Models #

V2 Models

• FullName - Bilingual name with English and Arabic

  class FullName {
    final String en;  // English name
    final String ar;  // Arabic name
  }
  

• Nationality - Nationality with bilingual name and ISO code

  class Nationality {
    final String en;
    final String ar;
    final String isoCode;  // e.g., "SA" for Saudi Arabia
  }
  

• FamilyMember - Family member details

  class FamilyMember {
    final String id;
    final FullName name;
    final int age;
    final Gender gender;
    final Relation relation;
  }
  

• Sponsor - Sponsor information

  class Sponsor {
    final String id;
    final FullName name;
    final Nationality nationality;
  }
  

V1 Models

• Vehicle - Vehicle registration details

  class Vehicle {
    final String plateNumber;
    final String brand;
    final String model;
    final int year;
    final String color;
    final String chassisNumber;
  }
  

• Violation - Traffic violation information

  class Violation {
    final String id;
    final DateTime date;
    final double amount;
    final String description;
    final String location;
    final bool isPaid;
  }
  

• Passport - Passport information

  class Passport {
    final String number;
    final String type;
    final DateTime issueDate;
    final DateTime expiryDate;
    final String issuingCountry;
  }
  

• Location - GPS coordinates

  class Location {
    final double latitude;
    final double longitude;
    final double? altitude;
    final double? accuracy;
  }
  

• NationalAddress - Saudi national address

  class NationalAddress {
    final String buildingNumber;
    final String street;
    final String district;
    final String city;
    final String region;
    final String postalCode;
    final String additionalNumber;
  }
  

• TwkFile - File/media data

  class TwkFile {
    final String fileName;
    final String mimeType;
    final String data;          // Base64 encoded
    final Uint8List binary;     // Decoded binary data
  }
  

• DeviceInfo - Device capabilities

  class DeviceInfo {
    final String platform;      // iOS, Android, Web
    final String version;
    final Map<String, bool> capabilities;
  }
  

Enumerations #

• Gender - User gender

  • Gender.male
  • Gender.female

• UserType - Type of user account

  • UserType.citizen - Saudi citizen
  • UserType.resident - Resident (Iqama holder)
  • UserType.visitor - Visitor/Tourist
  • UserType.gccCitizen - GCC country citizen

• BloodType - Blood group classification

  • BloodType.aPositive, BloodType.aNegative
  • BloodType.bPositive, BloodType.bNegative
  • BloodType.abPositive, BloodType.abNegative
  • BloodType.oPositive, BloodType.oNegative

• IqamaType - Iqama (residence permit) category

  • IqamaType.work - Work permit
  • IqamaType.family - Family residence
  • IqamaType.study - Student visa
  • IqamaType.hajj - Hajj/Umrah visa

• Relation - Family relationship types

  • Relation.father, Relation.mother
  • Relation.son, Relation.daughter
  • Relation.brother, Relation.sister
  • Relation.spouse
  • Relation.grandfather, Relation.grandmother

• MaritalStatus - Marital status

  • MaritalStatus.single
  • MaritalStatus.married
  • MaritalStatus.divorced
  • MaritalStatus.widowed

• DegreeType - Educational degree level

  • DegreeType.highSchool
  • DegreeType.diploma
  • DegreeType.bachelor
  • DegreeType.master
  • DegreeType.doctorate

✅ Testing #

The SDK includes comprehensive unit tests for all implementations:

Run All Tests #

flutter test

Run Specific Test File #

# Run the main test suite
flutter test test/twk_test.dart

Test Coverage #

# Generate coverage report
flutter test --coverage

# View coverage (requires lcov)
genhtml coverage/lcov.info -o coverage/html
open coverage/html/index.html

What's Tested #

• ✅ All V1 API methods (45+ methods)
• ✅ All V2 API methods (5 methods)
• ✅ Mock data parsing and serialization
• ✅ Type safety and model validation
• ✅ Edge cases and error handling
• ✅ Enum conversions
• ✅ File handling and binary data

Example Test #

test('getUserFullName returns correct bilingual name', () async {
  final api = TwkApiV2DemoJsonImpl();
  final fullName = await api.getUserFullName();
  
  expect(fullName.en, isNotEmpty);
  expect(fullName.ar, isNotEmpty);
  expect(fullName, isA<FullName>());
});

\ud83e\uddea Mock/Demo Implementation #

The SDK includes a comprehensive mock implementation for testing and development without actual Tawakkalna integration:

Automatic (Default) #

// Automatically uses mock implementation
final twk = TwkHelper();

Explicit Configuration #

import 'package:tawakkalna_sdk_flutter/tawakkalna_sdk_flutter.dart';

// Explicitly set mock implementations
final twk = TwkHelper(
  v1Api: TwkApiV1DemoJsonImpl(),
  v2Api: TwkApiV2DemoJsonImpl(),
);

Mock Data Source #

Mock data is loaded from assets/mock_profile1.0.2.json which contains:

• Realistic user profiles with Saudi Arabian data
• Multiple family members with diverse demographics
• Vehicle registrations and traffic violations
• Passport and document information
• National addresses in Saudi format
• Health and education data

Benefits #

• \u2705 No Authentication Required - Test without real credentials
• \ud83d\udea6 Predictable Data - Consistent responses for testing
• \ud83d\ude80 Fast Development - No network latency
• \ud83d\udcdd Documentation - See example data structures
• \ud83e\uddb5 Edge Cases - Test various data scenarios

\ud83d\udd27 Custom Implementation #

To integrate with actual Tawakkalna services or create your own data source:

import 'package:tawakkalna_sdk_flutter/tawakkalna_sdk_flutter.dart';

// Implement V1 API
class MyTwkApiV1 extends TwkApiV1 {
  @override
  Future<Map<String, dynamic>> getUserId() async {
    // Your implementation - e.g., REST API call
    final response = await http.get('https://api.example.com/user/id');
    return jsonDecode(response.body);
  }
  
  @override
  Future<Map<String, dynamic>> getUserFullName() async {
    // Your implementation
    return {'en': 'John Doe', 'ar': 'جون دو'};
  }
  
  // Implement all other required methods...
}

// Implement V2 API
class MyTwkApiV2 extends TwkApiV2 {
  @override
  Future<FullName> getUserFullName() async {
    // Your implementation
    return FullName(en: 'John Doe', ar: 'جون دو');
  }
  
  // Implement all other required methods...
}

// Use custom implementation
void main() {
  final twk = TwkHelper(
    v1Api: MyTwkApiV1(),
    v2Api: MyTwkApiV2(),
  );
}

\ud83e\udeb5 Debugging & Logging #

The SDK includes a built-in logger for debugging and monitoring:

Enable Logging #

import 'package:tawakkalna_sdk_flutter/tawakkalna_sdk_flutter.dart';

void main() {
  // Enable logging
  TwkLogger.instance.setEnabled(true);
  
  // Listen to log events
  TwkLogger.instance.addListener(() {
    final logs = TwkLogger.instance.logs;
    print('Total logs: ${logs.length}');
  });
  
  // Your app code...
}

Logger Features #

• \ud83d\udccb Automatic Logging - All API calls logged with request/response data
• \ud83d\udcc8 Statistics - Track total logs, errors, warnings, and info messages
• \ud83d\udd0d Filtering - Filter logs by level (error, warning, info)
• \ud83d\udcbe Memory Management - Automatic cleanup at 1000 log limit
• \ud83d\udd07 Toggle On/Off - Enable/disable logging at runtime
• \ud83d\udcf1 UI Integration - Built-in log viewer in example app

Log Viewer (Example App) #

The example app includes an integrated log viewer:

• Real-time log display with color coding
• Statistics dashboard (total, errors, warnings, info)
• Search and filter capabilities
• Copy logs to clipboard
• Clear logs functionality

// In your UI
ElevatedButton(
  onPressed: () {
    // Disable logging to prevent memory issues in production
    TwkLogger.instance.setEnabled(false);
  },
  child: Text('Disable Logs'),
);

Disable Logging in Production #

void main() {
  // Disable in production builds
  if (kReleaseMode) {
    TwkLogger.instance.setEnabled(false);
  }
}

📱 Platform Support #

Important: This SDK is designed for building mini apps that run inside the Tawakkalna super app. Mini apps are HTML/JavaScript applications built with Flutter Web. Real data access is only available when your compiled Flutter Web app runs within the official Tawakkalna mobile app (Android/iOS) through their mini apps platform. Desktop platforms are provided for development and testing with mock data only.

Web Platform Considerations #

For web platform, the SDK uses JavaScript interop. Choose the appropriate JavaScript file based on your use case:

For Development/Testing (Mock Data)

<!-- Add to your index.html for development with mock data -->
<script src="assets/packages/tawakkalna_sdk_flutter/assets/web/twkhelper_mock.js"></script>

For Production (Tawakkalna App)

<!-- Add to your index.html for production deployment to Tawakkalna -->
<script src="assets/packages/tawakkalna_sdk_flutter/assets/web/twkhelper.js"></script>

The JavaScript bridge provides:

• Mock Mode (twkhelper_mock.js): Mock data for local testing and development
• Production Mode (twkhelper.js): Real data access when running in Tawakkalna app
• Type-safe communication between Dart and JavaScript
• Support for all SDK features on web

Minimum Requirements #

• Dart SDK: ≥ 3.5.4
• Flutter SDK: ≥ 3.3.0
• Android: API 21+ (Android 5.0 Lollipop)
• iOS: iOS 12.0+
• Web: Modern browsers (Chrome, Firefox, Safari, Edge)

💡 Best Practices #

1. Use Mock Implementation for Development #

// Development
final twk = TwkHelper(); // Uses mock by default

// Production
final twk = TwkHelper(
  v1Api: TwkApiV1ProductionImpl(),
  v2Api: TwkApiV2ProductionImpl(),
);

2. Handle Errors Gracefully #

try {
  final fullName = await twk.getUserFullName();
  print('User: ${fullName.en}');
} catch (e) {
  print('Error fetching user data: $e');
  // Show user-friendly error message
}

3. Cache Frequently Accessed Data #

class UserService {
  final TwkHelper twk = TwkHelper();
  FullName? _cachedName;
  DateTime? _cacheTime;
  
  Future<FullName> getUserFullName() async {
    // Cache for 5 minutes
    if (_cachedName != null && 
        _cacheTime != null &&
        DateTime.now().difference(_cacheTime!) < Duration(minutes: 5)) {
      return _cachedName!;
    }
    
    _cachedName = await twk.getUserFullName();
    _cacheTime = DateTime.now();
    return _cachedName!;
  }
}

4. Disable Logging in Production #

import 'package:flutter/foundation.dart';

void main() {
  if (kReleaseMode) {
    TwkLogger.instance.setEnabled(false);
  }
  runApp(MyApp());
}

5. Use Type-Safe Enums #

// Good - Type safe
final males = await twk.getUserFamilyMembers(
  gender: Gender.male,  // Enum
);

// Avoid - Hardcoded values (not supported)
// Always use the Gender enum for type safety

🔧 Troubleshooting #

Issue: "No data returned from API" #

Solution: Ensure you're using the correct implementation:

// For testing/development
final twk = TwkHelper(); // Uses mock data

// For production
final twk = TwkHelper(
  v1Api: YourProductionV1Impl(),
  v2Api: YourProductionV2Impl(),
);

Issue: "Type mismatch errors" #

Solution: All methods return strongly-typed models:

// Returns typed FullName model
final FullName name = await twk.getUserFullName();

// Returns int
final int userId = await twk.getUserId();

// Returns list of typed objects
final List<Vehicle> vehicles = await twk.getUserVehicles();

Issue: "Logger consuming too much memory" #

Solution: Disable logger when not needed:

TwkLogger.instance.setEnabled(false);

Issue: "Web platform not working" #

Solution: Ensure you've completed the Web Platform Setup by adding the required JavaScript bridge file to your web/index.html. The SDK requires either twkhelper.js (production) or twkhelper_mock.js (development) to be loaded for web platform support.

📜 API Reference #

Detailed API documentation is available:

Quick Reference #

Complete Method List #

See the following documentation resources:

• This SDK's API Documentation - Detailed Dart/Flutter method signatures and parameters
• Official Tawakkalna Developer Documentation - Official developer guide for Tawakkalna mini apps platform

TwkHelper API Methods Checklist #

Authentication

Personal Information

Contact Information

Documents

Health & Status

Education & Career

Family & Relationships

Vehicles & Violations

Gallery

Camera

Files

Permissions

Scanner

Device Info

Legend:

• ✅ = Implemented and tested
• ❌ = Error or not working
• ⬜ = Not yet implemented/tested
• Memory Mock = In-memory mock implementation (TwkApiV1DemoJsonImpl / TwkApiV2DemoJsonImpl)
• JS Mock = JavaScript bridge mock (twkhelper_mock.js)
• SDK = Production SDK implementation (twkhelper.js)

🛣️ Roadmap #

Planned Features #

• ❌ Test Coverage - Increase test coverage to be 100%
• ❌ Integration Testing - Integration testing on Tawakkalna Developer Test App

Version History #

• 0.0.1-alpha.1 - Initial release with V1 and V2 APIs, bug fixes, and comprehensive documentation

🤝 Contributing #

Contributions are welcome! We appreciate:

How to Contribute #

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Make your changes
4. Add tests for new functionality
5. Run tests: flutter test
6. Commit your changes: git commit -m 'Add amazing feature'
7. Push to branch: git push origin feature/amazing-feature
8. Open a Pull Request

Contribution Guidelines #

• Follow existing code style and conventions
• Add tests for new features
• Update documentation (README, code comments)
• Ensure all tests pass
• Keep commits atomic and well-described

Areas for Contribution #

• 🐛 Bug fixes
• ✨ New features
• 📝 Documentation improvements
• 🎨 UI/UX enhancements
• ⚡ Performance optimizations
• 🌐 Translations
• ✅ Test coverage

💬 Support & Community #

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Official Tawakkalna Docs: Developer Documentation
• Email: Contact Maintainer

⚖️ License #

This project is licensed under the terms specified in the LICENSE file.

🚀 About Vision 2030 #

This SDK supports Saudi Arabia's Vision 2030 initiative by:

• 🏛️ Digital Government - Enabling seamless digital services
• 📱 Smart Solutions - Mobile-first approach to government services
• 🔒 Data Security - Secure access to personal information
• 🌐 Accessibility - Making services available to all residents
• 🚀 Innovation - Fostering digital transformation

Learn more about Saudi Vision 2030.

Made with ❤️ for Saudi Arabia's Digital Future

GitHub • pub.dev • Report Bug • Request Feature