Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 2.54 KB

README.md

File metadata and controls

83 lines (64 loc) · 2.54 KB
Raw

Boilerplate Service

A boilerplate micro service that runs as docker or lambda. Click "Use this Template" to use this for your service.

CI

follow me:

Key Stack Components

  • Express
  • Mongoose -> MongoDB
  • Serverless-http
  • openAPI/Swagger
  • Express-OpenAPI-Validate
  • @hapi/boom
  • oData API query
  • JSON Patch
  • Babel (see libs in package.json)
  • Passport (see libs in package.json)
  • Jest

Features

  • Authentication and Authorization via Core EOS (unitedeffects.com)
  • Configurable MongoDB connection to stand-alone or replica (or atlas)
  • oData support for queries
  • JSON Patch implemented for updates with mongodb
  • OpenAPI (swagger) and Swagger UI (/swagger)
  • Automatic API Documentation Generated via ReDoc (/api)
  • Automatic schema validation using the OpenAPI spec built in as middleware
  • Error handling via @hapi/Boom
  • Configurable logging with optional DB persistence
  • Works with Docker or Lambda
  • Jest test harness

Have other ideas? Feel free to PR!

oData Spec

https://www.odata.org/documentation/

JSON Patch

http://jsonpatch.com/

DB

If you'd rather use a different database or ODM, the following modifications are necessary:

  • change connection.js to the appropriate DB
  • validate that slsapp and start both correctly implement connection.js
  • in each of your api/resources, change the dal.js file to access the new DB using the new ODM/ORM

Quickstart Run

  • Click "Use this Template" at the top of the repository and setup your project
  • clone your project to your machine
  • start mongodb on port 27017
    • I find the easiest way to do this is via docker in a terminal
    • docker run -p 27017:27017 mongo
  • Copy ./.env_ci to ./.env and modify env.dev.json to set runtime configuration data
  • yarn
  • yarn test
  • yarn run dev
  • navigate to localhost:3000

Configure For Your Service

  • Update the following in package.json
    • name
    • author
    • person
    • description
    • homepage (your website or project website)
    • logo (your logo or project logo url)
  • Do the above quickstart now...
  • add src/api resources using the logging example
    • You will also want to update the ci/codefresh.yaml file to point to your repo
    • Note that my CI only tests, there is no deploy stage, you'll need to add it