https://github.com/amsokol/gcp-cloud-functions-typescript-starter
Google (Cloud Platform) Cloud Functions TypeScript starter project
https://github.com/amsokol/gcp-cloud-functions-typescript-starter
example gcp gcp-cloud-functions google-cloud-functions google-cloud-platform javascript nodejs starter template typescript
Last synced: 2 months ago
JSON representation
Google (Cloud Platform) Cloud Functions TypeScript starter project
- Host: GitHub
- URL: https://github.com/amsokol/gcp-cloud-functions-typescript-starter
- Owner: amsokol
- License: apache-2.0
- Created: 2017-07-16T20:19:45.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-17T21:04:22.000Z (almost 8 years ago)
- Last Synced: 2025-03-26T06:51:06.434Z (3 months ago)
- Topics: example, gcp, gcp-cloud-functions, google-cloud-functions, google-cloud-platform, javascript, nodejs, starter, template, typescript
- Language: TypeScript
- Homepage:
- Size: 19.5 KB
- Stars: 29
- Watchers: 2
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Google (Cloud Platform) Cloud Functions TypeScript starter project
- [Introduction](#introduction)
- [Clone project](#clone-project)
- [Build project (command-line)](#build-project-command-line)
- [Deploy project to Cloud Functions Local Emulator (command-line)](#deploy-project-to-cloud-functions-local-emulator-command-line)
- [Build bundle to deploy to Google Cloud Platform (command-line)](#build-bundle-to-deploy-to-google-cloud-platform-command-line)
## Introduction
Cloud Functions come in two distinct variants: foreground (HTTP) and background.
You invoke HTTP functions from standard HTTP requests.You can use background functions to handle events from your Cloud infrastructure, such as messages on a Google Cloud Pub/Sub topic, or changes in a Google Cloud Storage bucket. This project includes three example functions:
- `helloWorldHTTP` - foreground (HTTP) function
- `helloWorldPubSub` - background functions to handle Google Cloud Pub/Sub topic events
- `helloWorldStorage` - background functions to handle events from Google Cloud Storage bucket
## Clone project
Clone project from GitHub:
```bash
git clone https://github.com/amsokol/gcp-cloud-functions-typescript-starter.git
```
Go to to project folder:
```bash
cd gcp-cloud-functions-typescript-starter
```
Optional. You can open project in Visual Studio Code to to build and deploy project from GUI menu:
```bash
code .
```
## Build project (command-line)
If you prefer command-line interface instead of Visual Studio Code than use the next commands to build project.
Install required `npm` modules:
```bash
npm install
```
Compile TypeScript Cloud Function:
```bash
tsc
```
File `index.js` is generated and is ready to deploy to **Cloud Functions**
## Deploy project to Cloud Functions Local Emulator (command-line)
If you prefer command-line interface instead of Visual Studio Code than use the next commands to deploy project.
The **Cloud Functions Emulator** is distributed as a standard NPM package, so you can install it with a standard `npm install` command:
```bash
npm install -g @google-cloud/functions-emulator
```
Before you can deploy a function, you need to start the Emulator as follows:
```bash
functions start
```
Deploy an HTTP `helloWorld` function to the **Emulator** as follows:
```bash
npm run deploy-local
```
Open [helloWorld](http://localhost:8010/amsokol-me/us-central1/helloWorld) link in browser to see results.
See [Cloud Functions Local Emulator](https://cloud.google.com/functions/docs/emulator) for more details.
## Build bundle to deploy to Google Cloud Platform (command-line)
If you prefer command-line interface instead of Visual Studio Code than use the next commands to create zip archive for deployment.
For Windows using `PowerShell`:
```bash
npm run package-zip(windows)
```
For Linux/Unix using `zip` utility (you have to install it before):
```bash
npm run package-zip(linux)
```
It creates `helloWorld.zip` that includes `index.js`, `package.json`, `settings.json` files.
`helloWorld.zip` is ready to be deployed to **Google Cloud Platform**.
See [Deploying from Your Local Machine](https://cloud.google.com/functions/docs/deploying/filesystem) for more details.