https://github.com/noctisatrae/gunpoint

A restful API for Gun, a fully decentralized (peer-to-peer or multi-master) DB.
https://github.com/noctisatrae/gunpoint

api database express expressjs graph gun gunpoint javascript p2p rest-api webrtc

Last synced: 2 months ago
JSON representation

A restful API for Gun, a fully decentralized (peer-to-peer or multi-master) DB.

• Host: GitHub
• URL: https://github.com/noctisatrae/gunpoint
• Owner: noctisatrae
• License: apache-2.0
• Created: 2021-06-12T15:15:54.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-04-12T07:42:31.000Z (over 1 year ago)
• Last Synced: 2024-10-01T18:08:54.494Z (3 months ago)
• Topics: api, database, express, expressjs, graph, gun, gunpoint, javascript, p2p, rest-api, webrtc
• Language: JavaScript
• Homepage: https://gunpoint.herokuapp.com
• Size: 229 KB
• Stars: 10
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Logo](./gunpoint_banner.png)

# Gunpoint API

Gunpoint is a restful API for [gun.js](https://github.com/amark/gun). 

![Docker ?](https://github.com/noctisatrae/gunpoint/actions/workflows/docker-publish.yml/badge.svg) ![NPM Version ?](https://img.shields.io/npm/v/gunpoint) ![Issues ?](https://img.shields.io/github/issues/noctisatrae/gunpoint) ![Stars ?](https://img.shields.io/github/stars/noctisatrae/gunpoint)

You can fire it up with :

```sh

npm run start

```

or use `npx gunpoint` to instantly create a supercharged relay !

You can also use the Docker package :

```sh

docker pull ghcr.io/noctisatrae/gunpoint:master

```

If you want to try Gunpoint, [it's here !](https://gunpoint.herokuapp.com) (Main playground running latest release) \

\

**By the way, take a look at what's comming next :**

- [ ] A `/set` URI using `gun.set()`

- [ ] Be able to submit array (array to JS Object function)

- [ ] Redis caching support

- [ ] Improve CLI !

- - [ ] Find another way to make gunpoint beautiful !

- - [ ] Support passing args in command line.

- [X] Be able to configure Gun with `config.json`

- [X] Docker image with CI on `master` branch

## What you can do, currently :

`/get/[key]`: Use it to get data from a definied graph (`GET` request). \

`/put/[key] + request body (in JSON)`: Add data in a specified graph (`POST` request). \

`/put/[graph 1]/in/[graph 2]`: Put the graph 1 in the graph 2 (`POST` request). \

`/delete/[data]/in/[graph]`: Delete defined data in a specified graph (DELETE request).