https://github.com/mikaelvesavuori/triplecheck-example-cloud-functions
TripleCheck broker running on Google Cloud Functions and Firestore.
https://github.com/mikaelvesavuori/triplecheck-example-cloud-functions
consumer-contracts consumer-driven-contracts contract-testing pacts triplecheck
Last synced: about 2 months ago
JSON representation
TripleCheck broker running on Google Cloud Functions and Firestore.
- Host: GitHub
- URL: https://github.com/mikaelvesavuori/triplecheck-example-cloud-functions
- Owner: mikaelvesavuori
- License: mit
- Created: 2021-05-15T17:24:59.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-14T04:37:15.000Z (over 2 years ago)
- Last Synced: 2025-01-16T16:22:24.830Z (4 months ago)
- Topics: consumer-contracts, consumer-driven-contracts, contract-testing, pacts, triplecheck
- Language: JavaScript
- Homepage:
- Size: 582 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# triplecheck-example-cloud-functions
## TripleCheck broker running on Google Cloud Functions
This repo demonstrates a working, basic implementation of a [TripleCheck broker](https://github.com/mikaelvesavuori/triplecheck-broker) running on Google Cloud Functions with a Firestore database.
Refer to the documentation on the [broker](https://github.com/mikaelvesavuori/triplecheck-broker) for how to call the API.
Technology choices are:
- [Node.js](https://nodejs.org/en/)
- [Functions Framework](https://cloud.google.com/functions/docs/functions-framework)
## Pre-requisites
- A Google Cloud Platform account
- Logged in on GCP
- Sufficient credentials to deploy and use Cloud Functions and Firestore
- Enable Firestore (Native mode) in the GCP web console, create a database called `broker-demo` – if you change it you need to make sure that `src/index.ts` points to whatever you called your Firestore
- Configure `init.sh` and `deploy.sh` so they use your own values
## Installation
Run `npm install` or `yarn install` in both the root and `src` folders.
## Initialize GCP service account
**First ensure the details in `init.sh` are correct.**
Run `npm run init`.
## Local development
Run `npm start` or `yarn start`.
## Deploy
**First ensure the details in `deploy.sh` are correct.**
Run `npm run deploy` or `yarn run deploy`.