Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rubeniskov/cuser
Distributed messaging service 🌐, with no database, no config and using IPFS layer to distribute the storage all over the universe ♾️.
https://github.com/rubeniskov/cuser
cid conversation hash ipfs messaging service
Last synced: 20 days ago
JSON representation
Distributed messaging service 🌐, with no database, no config and using IPFS layer to distribute the storage all over the universe ♾️.
- Host: GitHub
- URL: https://github.com/rubeniskov/cuser
- Owner: rubeniskov
- License: mit
- Created: 2016-05-21T15:15:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T16:45:22.000Z (almost 2 years ago)
- Last Synced: 2024-11-22T17:12:22.982Z (about 1 month ago)
- Topics: cid, conversation, hash, ipfs, messaging, service
- Language: JavaScript
- Homepage:
- Size: 15.8 MB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
>**C**hatting via **U**ncentralized **S**ervice with **E**ndless **R**esources
Distributed messaging service 🌐, with no database, no config and using IPFS layer to distribute the storage all over the universe ♾️.
## Status
[](https://github.com/rubeniskov/cuser/actions?query=workflow%3Atesting)
[](https://github.com/rubeniskov/cuser/actions?query=workflow%3Arelease)
[](https://codecov.io/gh/rubeniskov/cuser)
[](https://patreon.com/rubeniskov)
[](https://github.com/sponsors/rubeniskov)
[](https://paypal.me/rubeniskov)
## Motivation
Many times I've try to create a webpage where the users can publish their opinions, but it becomes a hard task when you have to prepare an entire ecosystem to store such data. If the information is public, why not distribute such content all over the internet?.
Here is where `cuser` comes out, taking the powerfull of IPFS, stores the comments using the DAG graph.
This allows create [SPA's Single Page Aplications](https://es.wikipedia.org/wiki/Single-page_application) with capabilities of [statefull](https://www.atlantic.net/vps-hosting/what-is-stateless-stateful-models-web-development/) websites, blogs, etc... and minimize the storing impact of your server.
- Root CID represents the main article which is associated to a hash in IPFS, it can be created using the CID provider of IPFS if the article is not a IPFS distributed file.
## Getting started
```shell
npm install -g cuser
```
## Spam detection
IPFS manage the data in a fashion way, due the CID is generated using a checksum of the content data, so its really easy to track if the user is publishing the same content in many articles and restrict. A user can not publish repeated comments with the same content.
## Restricted comments tree
A user can only replay the last comment, so a user can not replay on himself. This allows to make a conversation where the user only has the capability (if a mistake) to edit his last post until other user continues the conversation.
## Removing / Editing comments
Even though IPFS is a permanet store due p2p distribution, if a user wants to remove a comment, can be done using hash tree which is manipulated at the server side allowing remove or replace a blocks.
## Security
A user can only edits/remove his owns comments, this is a feature which the `@cuser/server` takes on. Checking the user token which is provided by the server itself adding this security layer for prevent users to change other users comments.
## Diagram
## Packages
List of packages currently in existence for cuser
| name | description | version | coverage | downloads |
| ---------|---------|---------|---------|--------- |
| **Cuser** |
| [`@cuser/cli`](//github.com/rubeniskov/cuser/tree/master/packages/cli) | command line interface | [](https://www.npmjs.com/package/@cuser/cli) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/cli) |
| [`@cuser/core`](//github.com/rubeniskov/cuser/tree/master/packages/core) | Core ipfs wrapper | [](https://www.npmjs.com/package/@cuser/core) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/core) |
| [`@cuser/publisher`](//github.com/rubeniskov/cuser/tree/master/packages/publisher) | backend publisher logic | [](https://www.npmjs.com/package/@cuser/publisher) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/publisher) |
| [`@cuser/reader`](//github.com/rubeniskov/cuser/tree/master/packages/reader) | messages reader from the ipfs transport layer | [](https://www.npmjs.com/package/@cuser/reader) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/reader) |
| [`@cuser/auth`](//github.com/rubeniskov/cuser/tree/master/packages/auth) | auth core utility | [](https://www.npmjs.com/package/@cuser/auth) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/auth) |
| [`@cuser/store`](//github.com/rubeniskov/cuser/tree/master/packages/store) | store tree changes managment | [](https://www.npmjs.com/package/@cuser/store) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/store) |
| [`@cuser/crypto`](//github.com/rubeniskov/cuser/tree/master/packages/crypto) | cuser crypto utilities | [](https://www.npmjs.com/package/@cuser/crypto) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/crypto) |
| [`@cuser/validator`](//github.com/rubeniskov/cuser/tree/master/packages/validator) | json schema validator | [](https://www.npmjs.com/package/@cuser/validator) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/validator) |
| [`@cuser/utils`](//github.com/rubeniskov/cuser/tree/master/packages/utils) | common utils used by cuser | [](https://www.npmjs.com/package/@cuser/utils) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/utils) |
| [`@cuser/client`](//github.com/rubeniskov/cuser/tree/master/packages/client) | client logic for reading and publishing message using restfull transport | [](https://www.npmjs.com/package/@cuser/client) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/client) |
| [`@cuser/server`](//github.com/rubeniskov/cuser/tree/master/packages/server) | http server with express | [](https://www.npmjs.com/package/@cuser/server) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/server) |
| **Clients** |
| **Types** |
| [`@cuser/proto`](//github.com/rubeniskov/cuser/tree/master/packages/proto) | typing, schemas and services based in protocol buffers | [](https://www.npmjs.com/package/@cuser/proto) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/proto) |
| **Middlewares** |
| [`@cuser/express-middleware-auth`](//github.com/rubeniskov/cuser/tree/master/packages/express-middleware-auth) | | [](https://www.npmjs.com/package/@cuser/express-middleware-auth) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/express-middleware-auth) |
| [`@cuser/express-middleware-rest`](//github.com/rubeniskov/cuser/tree/master/packages/express-middleware-rest) | | [](https://www.npmjs.com/package/@cuser/express-middleware-rest) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/express-middleware-rest) |
| [`@cuser/express-middleware-graphql`](//github.com/rubeniskov/cuser/tree/master/packages/express-middleware-graphql) | | [](https://www.npmjs.com/package/@cuser/express-middleware-graphql) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/express-middleware-graphql) |
| **Integrations** |
| [`@cuser/react`](//github.com/rubeniskov/cuser/tree/master/packages/react) | react ui components for visualize cuser | [](https://www.npmjs.com/package/@cuser/react) | [](https://codecov.io/gh/rubeniskov/cuser) | [](https://www.npmjs.com/package/@cuser/react) |
# Development
Being a workspaced based mono repo project, yarn `>=1.5.0` is needed to allow local development
### Installing dependencies
```
yarn install
```
### Release
```shell
GITHUB_ACCESS_TOKEN= npm run release {version_number}
```