Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 2.01 KB

README.md

File metadata and controls

75 lines (48 loc) · 2.01 KB

KintoHub {name}-example

Overview

TODO: Cool description / goal of what technology you are bringing onto the plate with what language. This should be sweet and concise.

Live Example

About KintoHub:

KintoHub aligns teams to ship & operate cloud native apps with ease. Learn More

[Optional] Requirements

  • Ensure you have an account on KintoHub
  • [Optional] Required Kintohub features: [list features] (like pro sub features)
  • [Optional] specific packages needed for project to run

Deployment

  1. Apply this template to your Github
  2. Create a KintoBlockType and include:

You're now good to build! Click Build Latest Commit. Once complete, Click Now click Add To Project.

  1. Create Project and include:

You're ready to go live Click Deploy

Build & Deployment Configurations

Use the following examples for build or deployment environment variables:

Installation & Local Run

  1. npm install?
  2. npm run prod?

Test

  1. npm test

Usage

The following works with our Live Example:

API Call

GET http://localhost:8080/hello

Response

{
"hello": "world"
}

TODO: (Deleteme) Checklist

  • Create dev / prod example
  • Write clear instructions on how to add it to kintohub
  • (optional) write further instruction on how to fine tune it for production
  • Create tags for the example repository (kintohub, examples, related technologies)
  • Create new example on kinto-docs (add to sidebar + create new page)
  • Double check call URLs and ensure they are appropriate to your username

Common Snippets:

Below are common urls/instructions that could be copy/pasted in some examples. (KintoBlock links, instructions for HA on KintoHub, etc)

Please create PR for future snippets.