@flowerbox/api v0.1.0

flowerboxApi

A base API that Flowerbox Software utilizes. All of our API projects use and expand upon this as. This is a simple API layer to communicate with Couchbase or Postgres databases.

Motivation

Building out a dead simple base node framework for us or anybody to use. The idea is to have a solid base package, and your service tier code can focus on business logic.

Installation

This framework is meant to be a dead simple and expandable API implementation. Just install via npm and see instructions for use below.

Instructions for Use

This is designed to be the service tier when paired with the @flowerbox/Ui front end. By default it will process and run queries defined in your application

Configuration/Startup

notes on creating a configuration object and calling start...

Creating a postgres query

example code to create a simple postgres query

Creating a couchbase query

example code to create a simple couchbase query

Adding a custom controller

example code for creating a custom controller to do other work

Authors

• Alex Cottner - Initial work
• Tim Sullivan - inspiration

License

Copyright 2020 Flowerbox Software. Contributions by Alex Cottner and Tim Sullivan.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.