doesdev / oacp

Of A Certain Pattern - A framework of sorts

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Don't Use This

This was long abandoned in favor of the same pattern in a more optimal form.

If you have been using this for some reason, please see SCRUD as it is maintained and altogether better.

OACP - Of A Certain Pattern

A framework of sorts

It's SCRUD all the way down, and some Postgres too

This library was built to fit a very specific pattern.

Opinionated is an understatement. This is a super strict implementation of a particular pattern. Use this and stray from it to your own peril.

The gist of it is this:

  • use it to create SCRUD driven APIs / Micro-APIs
  • data storage and access is PG function driven
  • all PG functions accept and return JSONB
  • all PG function follow the naming convention below
    • namespace_model_action
  • JWT authorization
  • strict JWT format drives access control

Documentation is non-existent

It is my intent to add docs, but due to the nature of the project it is assumed no one else is using this. If you've read the description or looked at the source and are interested in docs open an issue and I'll prioritize it.

About

Of A Certain Pattern - A framework of sorts

License:MIT License


Languages

Language:JavaScript 100.0%