https://github.com/mikaelvesavuori/triplecheck-example-cloudrun
TripleCheck broker running on Google Cloud Run with Firestore.
https://github.com/mikaelvesavuori/triplecheck-example-cloudrun
consumer-contracts consumer-driven-contracts contract-testing pacts triplecheck
Last synced: about 2 months ago
JSON representation
TripleCheck broker running on Google Cloud Run with Firestore.
- Host: GitHub
- URL: https://github.com/mikaelvesavuori/triplecheck-example-cloudrun
- Owner: mikaelvesavuori
- License: mit
- Created: 2021-05-15T17:30:56.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-12T16:05:53.000Z (almost 2 years ago)
- Last Synced: 2025-01-16T16:22:26.030Z (4 months ago)
- Topics: consumer-contracts, consumer-driven-contracts, contract-testing, pacts, triplecheck
- Language: TypeScript
- Homepage:
- Size: 640 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# triplecheck-example-cloudrun
## TripleCheck broker running on Google Cloud Run with Firestore
This repo demonstrates a working, basic implementation of a [TripleCheck broker](https://github.com/mikaelvesavuori/triplecheck-broker) running on Google Cloud Run with Firestore as the 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/)
- [TypeScript](https://www.typescriptlang.org)
## Pre-requisites
- A Google Cloud Platform account
- Logged in to GCP
- Sufficient credentials to deploy and use Cloud Run 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`.
## Docker
Run `npm run docker:build` or `npm run docker:start` respectively to build and run a container.
## Deploy
**First ensure the details in `deploy.sh` are correct.**
Note: There is no need to use Docker manually to build the container when we let `gcloud` handle the deployment and build process.
Run `npm run deploy` or `yarn run deploy`.