Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lmangani/gunstore.io
Store your data in Gun DB by sending simple HTTP requests - based on jsonstore.io :floppy_disk: :rocket:
https://github.com/lmangani/gunstore.io
api datastore gun gundb gunicorn jsonstore simple store
Last synced: 22 days ago
JSON representation
Store your data in Gun DB by sending simple HTTP requests - based on jsonstore.io :floppy_disk: :rocket:
- Host: GitHub
- URL: https://github.com/lmangani/gunstore.io
- Owner: lmangani
- License: mit
- Created: 2018-04-09T01:31:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-23T23:41:47.000Z (over 1 year ago)
- Last Synced: 2024-10-03T12:37:43.380Z (about 1 month ago)
- Topics: api, datastore, gun, gundb, gunicorn, jsonstore, simple, store
- Language: JavaScript
- Homepage:
- Size: 1.16 MB
- Stars: 37
- Watchers: 7
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Start storing your data in the cloud in 2 seconds
[](https://heroku.com/deploy)
## About
**gunstore** is a clone of [jsonstore](https://github.com/bluzi/jsonstore) and provides a datastore for small projects based on [Gun DB](https://github.com/amark/gun).
Just launch and access your instance, copy the URL and start sending HTTP requests to communicate with your datastore.
POST requests will save data, PUT requests modify data, DELETE requests delete data and GET requests retrieves data.
## Examples
Make sure to replace the URL in the examples to your actual endpoint URL!
```bash
npm install
npm start
```
### CURL
#### POST
The following command will create a user in `/users/1`:
```shell
curl -XPOST -H "Content-type: application/json" -d '{
"name": "john.snow",
"age": 31
}' 'http://localhost:3000/cf024bb815a93131ce9fed91b1f9dafa43a3c557e9be66e66fd76df5c64f10fe/users/1'
```
#### GET
The following command will retrieve the user we created earlier:
```shell
curl -XGET 'http://localhost:3000/cf024bb815a93131ce9fed91b1f9dafa43a3c557e9be66e66fd76df5c64f10fe/users/1'
```
#### PUT
The following command will change the age of the user to `32`:
```shell
curl -XPUT -H "Content-type: application/json" -d '32' 'http://localhost:3000/cf024bb815a93131ce9fed91b1f9dafa43a3c557e9be66e66fd76df5c64f10fe/users/1/age'
```
#### DELETE
The following command will delete the user:
```shell
curl -XDELETE 'http://localhost:3000/cf024bb815a93131ce9fed91b1f9dafa43a3c557e9be66e66fd76df5c64f10fe/users/1'
```
### JavaScript
#### POST
```js
fetch('http://localhost:3000/cf024bb815a93131ce9fed91b1f9dafa43a3c557e9be66e66fd76df5c64f10fe/users/1', {
headers: {
'Content-type': 'application/json'
},
method: 'POST',
body: { name: 'john snow', age: 31 },
});
```
#### GET
```js
const user = await fetch('http://localhost:3000/cf024bb815a93131ce9fed91b1f9dafa43a3c557e9be66e66fd76df5c64f10fe/users/1')
.then(function(response) {
return response.json();
})
```
#### PUT
```js
fetch('http://localhost:3000/cf024bb815a93131ce9fed91b1f9dafa43a3c557e9be66e66fd76df5c64f10fe/users/1/age', {
headers: {
'Content-type': 'application/json'
},
method: 'PUT',
body: 32,
});
```
#### DELETE
```js
fetch('http://localhost:3000/cf024bb815a93131ce9fed91b1f9dafa43a3c557e9be66e66fd76df5c64f10fe/users/1', {
method: 'DELETE',
});
```
### Contribution
Any type of feedback, pull request or issue is welcome.
## Acknowledgements
**gunstore** is a clone of [jsonstore](https://github.com/bluzi/jsonstore) by [bluzi](https://github.com/bluzi)