Git Product home page Git Product logo

airbin's Introduction

Airbin ๐ŸŒช

A simple http key value db service over airtable database for easy access of key value pairs just like jsonbin, made and deployed with deno. Trying Deno for the first time.

Now you don't need to signup for any free tier or buy any costly storage login directly with github and start building. Each user get a base and we call it Airbase.

Live On ๐ŸŸข

https://airbin.deno.dev/

Login to get started

https://airbin.deno.dev/_/login

Airbin can be deployed on own as ONLY_SELF_HOSTED for personal easy data storage

API Documentation ๐Ÿ“˜

  • The rest api is very simple to use but has some limitations

Limitations

  • Each user only get 1200 keys.
  • Each request has a soft limit of 4 MiB data.
  • So technically you get nearly 4 GiB storage which is good for small projects

- GET

https://airbin.deno.dev/:USER_ID/:KEY

This request gets the value without token if data is set to public else token is required and returns null if no data is present at that space.

Headers ๐Ÿ“ƒ

Header Description
Authorization Bearer :TOKEN
The token can be obtained after /_/login.

OPTIONS โš™

Query Required? Description
USER_ID REQUIRED The airbase userid. can be obtained from /_/me after /_/login.
KEY REQUIRED The key where the value is saved.

- POST

https://airbin.deno.dev/:USER_ID/:KEY

This request puts the value in the :KEY and if key already has a value it overwrites the value.

Headers ๐Ÿ“ƒ

Header Description
Authorization Bearer :TOKEN
The token can be obtained after /_/login.

OPTIONS โš™

Body Required? Description
Body REQUIRED Body should be the value to store can be plain or json (prefer json).

- PATCH

https://airbin.deno.dev/:USER_ID/:KEY

This request can alter the data access to be pulbic or private(can be accessed without a token or not).

Headers ๐Ÿ“ƒ

Header Description
Authorization Bearer :TOKEN
The token can be obtained after /_/login.

OPTIONS โš™

Body (JSON) Required? Description
public REQUIRED trueor false.

- DELETE

https://airbin.deno.dev/:USER_ID/:KEY

This request deletes the :KEY from the airbase.

Headers ๐Ÿ“ƒ

Header Description
Authorization Bearer :TOKEN
The token can be obtained after /_/login.

- GET

https://airbin.deno.dev/_/me

This request gets the user detail of the authenticated token (if accessing from program need to specify x-user header with value of userid).

Headers ๐Ÿ“ƒ

Header Description
Authorization Bearer :TOKEN
The token can be obtained after /_/login.
x-user :USER_ID
The userid only to be specified when accessing via curl or scripts

For Self Hosting

airbin can be selfhosted on any platform supporting deno after that just setup the Config.js and .ENV files.

Here ONLY_SELF_HOSTING means that login via github will be disabled and only admin can create the airbases via /_/create?airbase=Name

What is ADMIN_TOKEN? it is the token which admin specify to access any value and create airbases. Here admins means the one who is hosting.

โ„น ENV SPECIFICATIONS

Key Description
API_KEY The airtable personal access token.
WORKSPACE_KEY The airtable workspace id.
WORKSPACE_KEY The airtable workspace id.
CLIENT_ID Github oauth app client id optional for only self hosting.
CLIENT_SECRET Github oauth app client secret optional for only self hosting.
HASH_SECRET This secret is used to generate user tokens so keep it private and hard to guess.
ADMIN_TOKEN This is special admin token from which admin can access any airbase commands.

Note : Airtable has api limit of 5 req/sec

Bugs?

create the issue in the repo and i will try to fix it most probably.

No UI? small changes?, well contributions are welcomed.

Credits

HOSTED ON DENO DEPLOY

Deno.land

airbin's People

Contributors

shivam1608 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.