Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pubky/pubky-core
An open protocol for per-public-key backends for censorship resistant web applications.
https://github.com/pubky/pubky-core
client-server cloud pkarr publickey-authentication web
Last synced: about 7 hours ago
JSON representation
An open protocol for per-public-key backends for censorship resistant web applications.
- Host: GitHub
- URL: https://github.com/pubky/pubky-core
- Owner: pubky
- License: mit
- Created: 2023-12-07T15:23:01.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-11-14T12:30:06.000Z (6 days ago)
- Last Synced: 2024-11-14T13:24:30.580Z (6 days ago)
- Topics: client-server, cloud, pkarr, publickey-authentication, web
- Language: Rust
- Homepage: https://pubky.github.io/pubky-core/
- Size: 3.35 MB
- Stars: 28
- Watchers: 4
- Forks: 7
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
An open protocol for per-public-key backends for censorship resistant web applications.
> The Web, long centralized, must decentralize; Long decentralized, must centralize.
## Overview
Pubky-core combines a [censorship resistant public-key based alternative to DNS](https://pkarr.org) with conventional, tried and tested web technologies, to keep users in control of their identities and data, while enabling developers to build software with as much availability as web apps, without the costs of managing a central database.
## Features
- Public key based authentication.
- Public key based 3rd party authorization.
- Key-value store through PUT/GET/DELETE HTTP API + pagination.
## Getting started
This repository contains a [Homeserver](./pubky-homeserver), and a [Client](./pubky) (both Rust and JS wasm bindings).
You can a run a local homeserver using `cargo run` with more instructions in the README.
Check the [Examples](./examples) directory for small feature-focesed examples of how to use the Pubky client.
### JavaScript
If you prefer to use JavaScript in NodeJs/Browser or any runtime with Wasm support, you can either install from npm [`@synonymdev/pubky`](https://www.npmjs.com/package/@synonymdev/pubky)
or build the bindings yourself:
```bash
cd pubky/pkg
npm i
npm run build
```
#### Testing
There are unit tests for the JavaScript bindings in both NodeJs and headless web browser, but first you need to run a local temporary Homeserver
```bash
npm run testnet
```
Then in a different terminal window:
```bash
npm test
```