https://github.com/remotesynth/flex-service-samples
Examples of Kinvey Flex Services
https://github.com/remotesynth/flex-service-samples
Last synced: about 1 year ago
JSON representation
Examples of Kinvey Flex Services
- Host: GitHub
- URL: https://github.com/remotesynth/flex-service-samples
- Owner: remotesynth
- Created: 2018-03-01T18:22:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-03T19:12:37.000Z (about 7 years ago)
- Last Synced: 2025-03-24T10:56:26.692Z (about 1 year ago)
- Language: JavaScript
- Size: 95.7 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Kinvey FlexServices Examples
[FlexServices](https://devcenter.kinvey.com/html5/guides/flex-services) are microservices that can be used for data integrations or business logic within the [Kinvey mBaas](https://www.kinvey.com/). There are three types of FlexServices:
* **FlexData** for data integrations.
* **FlexAuth** for authentication integrations.
* **FlexFunctions** for business logic (along the lines of what is often called _serverless_). These can be used as custom endpoints, which can be called directly via REST or the Kinvey SDK, or can be added as business logic during the [collection hook pipeline](https://devcenter.kinvey.com/html5/reference/business-logic/reference.html#CollectionHookPipeline).
This repository contains a number of examples of FlexServices. The goal is to eventually offer a variety of examples of all the various types of FlexServices.
## Using the Example Services
To use each service, you'll have to add a new service within the service catalog on your Kinvey console. You'll also need the [Kinvey CLI](https://www.npmjs.com/package/kinvey-cli).
Navigate to the folder of the FlexService example that you'd like to use. Assuming you have already authenticated within the Kinvey CLI, you can run `kinvey flex init` to configure the service to connect it to the service that you created in the console (the CLI will walk you through the steps). Once this is complete, you can use `kinvey flex deploy` to deploy the service to the Kinvey Flex runtime (you could run them as External Flex as well - see the [FlexService Runtime guide](https://devcenter.kinvey.com/rest/guides/flexservice-runtime) for more details).
Each service is intended to be used differently as currently written. Some of the current examples are intended to be used as a [custom endpoint](https://devcenter.kinvey.com/rest/guides/business-logic#custom-endpoints), while others are intended to be used as [collection hooks](https://devcenter.kinvey.com/rest/guides/business-logic#collection-hooks). Please check the readme for each service as to its intended use.