ipfs_rpc 0.0.1 ipfs_rpc: ^0.0.1 copied to clipboard
An IPFS HTTP RPC Client for Dart & Flutter
IPFS RPC Client for Dart & Flutter
An IPFS HTTP RPC Client for Dart & Flutter
Report Bug
·
Request Feature
Table of Contents #
About The Project #
A clean and easy to use IPFS RPC Client for Dart & Flutter!
EXAMPLE PROJECT SCREENSHOT #
Supported Platforms #
- iOS
- Android
- Mac OS
- Windows
- Linux
- Web
Built With #
Google Flutter SDK
Getting Started #
Prerequisites #
- Flutter SDK
- Android SDK & Android Studio for deployment to Android
- XCode IDE for deployment to iOS/iPad/MacOS
- VS Code IDE optional
Installation #
- Clone the repo
git clone https://github.com/oliverbytes/ipfs_rpc.git
- Install packages dependencies
flutter pub get
- Run
flutter run
Usage #
// Import Package
import 'package:ipfs_rpc/ipfs_rpc.dart';
// Instantiate IPFS Object
final ipfs = IPFS();
// Optional - Configuration
ipfs.client.init(
scheme: 'http',
host: '127.0.0.1',
port: 5001,
verbose: true,
);
debugPrint('requesting...');
final result = await ipfs.files.ls();
result.fold(
(error) { // ERROR
debugPrint(error.toJson().toString());
},
(response) { // SUCCESS
debugPrint(response.toJson().toString());
},
);
debugPrint('request done');
Roadmap #
- Complete API
- Unit Testing
See the open issues for a list of proposed features (and known issues).
Contributing #
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License #
Distributed under the MIT License. See LICENSE
for more information.
Contact #
Oliver Martinez - @oliverbytes - nemoryoliver@gmail.com
Project Link: https://github.com/oliverbytes/ipfs_rpc