https://github.com/push-protocol/push-restapi-dart

https://github.com/push-protocol/push-restapi-dart

Last synced: 20 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/push-protocol/push-restapi-dart
• Owner: push-protocol
• License: bsd-3-clause
• Created: 2023-07-11T06:54:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-28T10:41:41.000Z (about 2 months ago)
• Last Synced: 2024-10-28T14:01:25.999Z (about 2 months ago)
• Language: Dart
• Size: 6.18 MB
• Stars: 5
• Watchers: 5
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        



    

    

    

    

    

    





  Push Protocol is a web3 communication network, enabling cross-chain notifications, messaging, video, and NFT chat for dapps, wallets, and services.🚀





  

    

  

  

    

  

  

    

  



Push Dart SDK 
 



Push SDK provides an abstraction layer to integrate Push protocol features with your Frontend as well as Backend.

This SDK is a dart based Monorepo of packages that helps developers to :

- Build PUSH features into their DApps

  - Notifications

  - Chat

  - Group Chat

  

without having to write a lot of boilerplate code. All the heavy lifting is done by the SDK, so that you the developer can focus on building features and bootstrap a DApp with PUSH features in no time!



## 📚 Table of Contents

- [Documentation](#documentation)

- [Getting Started](#-getting-started)

- [Resources](#resources)

- [Contributing](#contributing)

---

## Documentation

This package gives access to Push Protocol (Push Nodes) APIs. Visit [Developer Docs](https://docs.push.org/developers) or [Push.org](https://push.org) to learn more.

#### 1. [Wallet to Wallet Chat](doc/Chats.md)

#### 2. [Group Chat](doc/GroupChat.md)

#### 3. [Channels](doc/Chats.md)

#### 3. [Spaces](doc/Spaces.md)

---

## 🚀 Getting Started

### 🖥 Installation

 Add a line like this to your package's pubspec.yaml (and run an implicit dart pub get):

```bash

dependencies:

  push_restapi_dart: ^0.0.2-alpha

```

Alternatively, your editor might support ```dart pub get``` or ```flutter pub get```. Check the docs for your editor to learn more.

Import it

```sh

import 'package:push_restapi_dart/push_restapi_dart.dart' as push;

```

---

## Resources

- **[Website](https://push.org)** To checkout our Product.

- **[Docs](https://docs.push.org/developers/)** For comprehensive documentation.

- **[Blog](https://medium.com/push-protocol)** To learn more about our partners, new launches, etc.

- **[Discord](discord.gg/pushprotocol)** for support and discussions with the community and the team.

- **[GitHub](https://github.com/ethereum-push-notification-service)** for source code, project board, issues, and pull requests.

- **[Twitter](https://twitter.com/pushprotocol)** for the latest updates on the product and published blogs.

## Contributing

Push Protocol is an open source Project. We firmly believe in a completely transparent development process and value any contributions. We would love to have you as a member of the community, whether you are assisting us in bug fixes, suggesting new features, enhancing our documentation, or simply spreading the word. 

- Bug Report: Please create a bug report if you encounter any errors or problems while utilising the Push Protocol.

- Feature Request: Please submit a feature request if you have an idea or discover a capability that would make development simpler and more reliable.

- Documentation Request: If you're reading the Push documentation and believe that we're missing something, please create a docs request.

Read how you can contribute HERE

Not sure where to start? Join our discord and we will help you get started!



## License

Check out our License HERE