API for sec3hub.xyz

a standalone api, aggregate cleaned data to sec3hub.xyz frontend might become a api server for other projects and friends in the future. check out the interface here

Backgroud :

we felt adventurous so we are gave deno a try on production as a backend server.

Tech stack

• deno
  • runtime
• oak
  • rest framework
• postgresjs
  • postgres client
• fly
  • docker based serverless
• neon
  • Serverless Postgres

Setup

for local dev can create a .env file in the root directory. for production use process env variables.

install deno

curl -fsSL https://deno.land/x/install/install.sh | sh

or via homebrew

brew install deno

there are two tasks for deno test and dev

deno task dev

deno task test

via docker

docker build .  -t sec3back

docker run -it -p 8080:8080 sec3back

or with rm and detach

docker run -it -p 8080:8080 -d --rm sec3back

Deploy

it will automatically deploy to fly.io via github actions.

flyctl deploy

API Docs

there is insomia file in the root directory for testing the api. no fancy swagger docs yet.

Note endpoints return two headers

• x-keyword-count total number of searched keyword in the database
• x-row-count total number of rows returned from the database

Collaborations & Contributions & Sponsorship

Please contact via twitter @0xsha or @jeromevvb .

Or email to hello .