Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/soketi/monorepo

Last synced: 3 days ago
JSON representation
Host: GitHub
URL: https://github.com/soketi/monorepo
Owner: soketi
Created: 2024-01-20T15:38:35.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-05-06T05:32:03.000Z (6 months ago)
Last Synced: 2024-05-06T06:34:15.868Z (6 months ago)
Language: TypeScript
Size: 793 KB
Stars: 7
Watchers: 2
Forks: 0
Open Issues: 9
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # soketipfs — Real-Time 🤝 Web3

[![Discord](https://img.shields.io/discord/957380329985958038?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/VgfKCQydjb)

[![CI](https://github.com/soketi/monorepo/actions/workflows/ci.yml/badge.svg)](https://github.com/soketi/monorepo/actions/workflows/ci.yml)

soketipfs is a framework for building distributed applications using Websockets. It is built on top of [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) and uses the IPFS networking protocol with [Helia](https://github.com/ipfs/helia).

Use it in both public or private networks, where you can control the nodes that are part of the network — you have a fully private and secure network for your real-time application.

[Read more about Interstellar ✨🪐](https://interstellar.soketi.app)

## 🤝 Sponsors



  

    

  



## Features

### SRF (🌍 Scalable | ✨ Resilient | 🏎️ Fast)

soketipfs is built with the SRF principles in mind. It is designed to be scalable, resilient and fast by nature, leveraging the power of uWebSockets.js and the IPFS networking.

While IPFS is public, soketipfs is designed to be used in private networks, where you can control the nodes that are part of the network — you have a fully private and secure network for your real-time application. 🚀

The server is built on top of [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) - a C application ported to Node.js. uWebSockets.js is demonstrated to perform at levels [_8.5x that of Fastify_](https://alexhultman.medium.com/serving-100k-requests-second-from-a-fanless-raspberry-pi-4-over-ethernet-fdd2c2e05a1e) and at least [_10x that of Socket.IO_](https://medium.com/swlh/100k-secure-websockets-with-raspberry-pi-4-1ba5d2127a23). ([_source_](https://github.com/uNetworking/uWebSockets.js))

### Cheaper 🤑

For a $49 plan on Pusher, you get a limited amount of connections (500) and messages (30M).

With soketipfs, for the price of an instance on Vultr or DigitalOcean ($5-$10), you get virtually unlimited connections, messages, and some more!

soketipfs is capable to hold thousands of active connections with high traffic on less than **1 GB and 1 CPU** in the cloud. You can also [get free $100 on Vultr to try out soketipfs →](https://www.vultr.com/?ref=9032189-8H)

### Pusher Protocol 📡

soketipfs implements the [Pusher Protocol v7](https://pusher.com/docs/channels/library\_auth\_reference/pusher-websockets-protocol#version-7-2017-11). Your existing projects that connect to Pusher requires minimal code change to make it work with soketipfs - you just add the host and port and swap the credentials.

### **Coming Soon** 🚀✨

**AI & LLMs 🤖**: Leverage the market game within the real-time context — protect your customers with built-in AI models for sentiment analysis and much more.

**Function as a Service 🚀**: The network will have your code and it will run it for you. Zero knowledge required, and you use the languages you love.

**Storage-as-a-Service 🪣**: Your files will be safe. The network stores it for you, either it is public or private. No disruptions, no data loss.

## 🚀 Getting Started

Get started by using the new `soketi` CLI to start the server:

```bash

npx @soketi/cli ipfs start --port=7001

```

The CLI replaces the [soketi](https://github.com/soketi/soketi) project.

If you wish to install the command as global, make sure to uninstall the old `soketi` package before installing the new one:

```bash

npm uninstall -g @soketi/soketi

npm install -g @soketi/cli

```

```bash

# Now you can use the IPFS server

soketi ipfs start --port=7001

```

For the legacy server, see the [soketi/soketi](https://github.com/soketi/soketi) repository.

## 🔀 Roadmap

```text

🧑‍💻 = currently in development

👉 = upcoming for development

⏳ = planned, but not yet scheduled

👀 = not sure, maybe in the future

```

- [x] Deployment

  - [x] 🧑‍💻 New Soketi CLI

  - [x] 🧑‍💻 Docker

  - [ ] 👉 Kubernetes

  - [ ] 👉 Railway

- [ ] Protocols

  - [ ] 👉 Pusher Protocol

  - [ ] 👉 Ably Protocol

  - [ ] 👉 AWS API Gateway Protocol (compatibility)

  - [ ] ⏳ MQTT Protocol

  - [ ] ⏳ PubNub Protocol

  - [ ] ⏳ SockJS Protocol

  - [ ] ⏳ Socket.IO / Engine.IO Protocol

  - [ ] 👀 AMQP Protocol

  - [ ] 👀 Centrifugo Protocol

  - [ ] 👀 STOMP Protocol

- [x] Discovery Mechanisms

  - [x] 🧑‍💻 IPFS

  - [ ] ⏳ Redis Pubsub

  - [ ] ⏳ NATS

- [ ] Sprinkles

  - [ ] 👉 Function as a Service

  - [ ] 👉 AI & LLMs

  - [ ] ⏳ Storage as a Service

- [ ] Databases

  - [ ] 👉 Redis Stack

  - [ ] 👉 SQL via Knex

  - [ ] 👀 MongoDB

## ⁉ Ideas or Discussions?

Have any ideas that can make into the project? Perhaps you have questions? [Jump into the discussions board](https://github.com/soketi/monorepo/discussions) or [join the Discord channel](https://discord.gg/VgfKCQydjb)

## 🔒 Security

If you discover any security related issues, please email  instead of using the issue tracker.

## 🎉 Credits

Thank you to Bunny! 🌸

- [Pusher Protocol](https://pusher.com/docs/channels/library_auth_reference/pusher-websockets-protocol)

- [All Contributors](../../contributors)

- [All Contributors of soketi/soketi](https://github.com/soketi/soketi/graphs/contributors)

## 🤝 Contributing

✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨

### Learn more

- [Nx Documentation](https://nx.dev)

- [30-minute video showing all Nx features](https://nx.dev/getting-started/what-is-nx)

### Install dependencies

Run `npm install` to install all dependencies.

```bash

npm install

```

### Packages

Each abstraction has its own place in the soketipfs ecosystem, and they can be used independently or together.

soketipfs is a monorepo, and it's composed of the following packages:

- [brain](./packages/brain): Used to cache data in memory

- [cli](./packages/cli): the CLI took for soketi that supports both legacy and IPFS, plus possibly many more integratins

- [connections](./packages/connections): Base implementation for Websocket connections handling

- [gossiper](./packages/gossiper): Integration for the Gossip protocol, used to broadcast messages to all nodes in the network

- [p2p](./packages/p2p): libp2p networking implementation using Helia

- [server](./packages/server): Ready-to-go & customizable server implemenations for soketipfs

- [utils](./packages/utils): Utility functions used across the packages

#### Protocol: Pusher

The Pusher protocol is implemented in the following packages:

- [pusher-apps](./packages/pusher-apps): Pusher Apps implementation to juggle with the apps definitions

- [pusher-channels](./packages/pusher-channels): Pusher Channels implementation to handle channels and events