Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/push-protocol/push-swift-sdk
https://github.com/push-protocol/push-swift-sdk
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/push-protocol/push-swift-sdk
- Owner: push-protocol
- License: other
- Created: 2023-05-19T15:27:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-19T15:03:07.000Z (5 months ago)
- Last Synced: 2024-11-30T19:16:35.117Z (24 days ago)
- Language: Swift
- Size: 359 KB
- Stars: 3
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: license-v1.md
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 Swift SDK
Push SDK provides an abstraction layer to integrate Push protocol features with your Frontend as well as Backend.
This SDK is a swift 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](docs/Chats.md)
#### 2. [Group Chat](docs/GroupChat.md)
#### 3. [Channels](docs/Chats.md)
---
## 🚀 Getting Started
### 🖥 Installation
1. Clone the push-swift-sdk repository:
```sh
git clone https://github.com/ethereum-push-notification-service/push-swift-sdk
```
2. Change to the project directory:
```sh
cd push-swift-sdk
```
3. Install the dependencies:
```sh
swift build
```
### 🧪 Running Tests
```sh
swift test
```
---
## 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