🗃️ Boxx #

Secure • Simple • Fast Flutter Storage #

Store, retrieve, and protect your data effortlessly with AES or Fernet encryption

✨ Features #

Boxx is a lightweight storage solution with optional encryption built in. Its simple, powerful, & intuitive API gets you up and running in no time.

✅ Simple – Easy-to-use key-value interface
✅ Secure – Choose between AES-256 or Fernet encryption
✅ Fast – Optimized for performance with minimal overhead
✅ Versatile – Perfect for configs, secrets, or sensitive data

🚀 Getting Started #

Installation #

Add Boxx to your pubspec.yaml:

dependencies:
  boxx: ^0.1.7


## Import
```dart
import 'package:boxx/boxx.dart';

Getting started #

Without Encryption

late Boxx box;

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await initBox();
}

Future<void> initBox() async {
  box = Boxx(mode: EncryptionMode.none);
  await box.initialize();
}

With Encryption

late Boxx box;

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await initBox();
}

Future<void> initBox() async {
  box = Boxx(
    mode: EncryptionMode.aes,
    encryptionKey: 'your-32-character-encryption-key',
  );
  await box.initialize();
}

Usage #

Delete Data

await box.delete('UserData');

Retrieve Data

final contents = await box.get('UserData');

Store Data

await box.put('UserData', response.body);

Encryption Utilities

// Encrypt any string
String encrypted = box.encrypt('Hello World');
debugPrint(encrypted);

// Decrypt back to original
String decrypted = box.decrypt(encrypted);
debugPrint(decrypted); // Output: Hello World

🔧 API Reference

Core Methods #

Encryption Modes #

Alternatively, for a more concise version:

💡 Best Practices #

🤝 Contributing We welcome contributions! Please feel free to submit issues and pull requests.

📄 License This project is licensed under the MIT License.