Skip to content
/ q3-api Public

API framework built on Express and Mongoose

License

Notifications You must be signed in to change notification settings

3merge/q3-api

Repository files navigation

3merge

Q3 API

Q3 is a set of packages for scaffolding APIs.

🕮 Core Documentation

Name Description
Access Control Maintains all CRUD permissions for the API and DB
API The primary package of this project
Composer Generates REST endpoints with baked in authorization and validation
Exports Generates simple csv, xlsx and pdf files
Responder Helps report custom and intentional errors over the API
Scheduler Manages a worker queue for background tasking

🔌 Plugin Documentation

Name Description
Changelog Saves changes made to a document in a separate collection
Extended References Handles extended collection references and auto-population
N-grams Handles mongoose fuzzy searching and text indexing

🛤️ Versions

Note that starting in v2, the collection `q3-api-users` has been renamed to `users`. See `q3-api` docs for more details.

Name Key changes
V3 Change to notifications architecture and system counters
V2 Support multi-tenancy
V1 Upgrade critical dependencies