Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googlearchive/cloud-functions-emulator

A local emulator for deploying, running, and debugging Google Cloud Functions.
https://github.com/googlearchive/cloud-functions-emulator

cloud-functions-emulator emulator google-cloud google-cloud-functions

Last synced: 23 days ago
JSON representation

A local emulator for deploying, running, and debugging Google Cloud Functions.

Host: GitHub
URL: https://github.com/googlearchive/cloud-functions-emulator
Owner: googlearchive
License: apache-2.0
Archived: true
Created: 2016-10-24T16:42:35.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2019-05-15T16:32:16.000Z (over 5 years ago)
Last Synced: 2024-05-19T13:09:00.093Z (7 months ago)
Topics: cloud-functions-emulator, emulator, google-cloud, google-cloud-functions
Language: JavaScript
Homepage: https://github.com/GoogleCloudPlatform/cloud-functions-emulator/wiki
Size: 2.61 MB
Stars: 827
Watchers: 39
Forks: 115
Open Issues: 95
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Status: Archived

![status: inactive](https://img.shields.io/badge/status-inactive-red.svg)

This repository has been archived and is no longer maintained.

We recommend you use:

- **Google Cloud Functions:** The [functions framework](https://github.com/GoogleCloudPlatform/functions-framework-nodejs) which is the same library that powers functions for Node 10+.

- **Google Cloud Functions for Firebase:** The [local emulator](https://firebase.google.com/docs/functions/local-emulator) with [`firebase-tools`](https://github.com/firebase/firebase-tools).

Please see [Issue #327](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/issues/327) for more details.

---



# Google Cloud Functions Emulator

[![NPM][1]][2] [![Tests][3]][4] [![Coverage][5]][6]

[1]: https://img.shields.io/npm/v/@google-cloud/functions-emulator.svg?style=flat

[2]: https://www.npmjs.org/package/@google-cloud/functions-emulator

[3]: https://img.shields.io/circleci/project/GoogleCloudPlatform/cloud-functions-emulator.svg

[4]: https://circleci.com/gh/GoogleCloudPlatform/cloud-functions-emulator

[5]: https://img.shields.io/codecov/c/github/GoogleCloudPlatform/cloud-functions-emulator/master.svg

[6]: https://codecov.io/github/GoogleCloudPlatform/cloud-functions-emulator

_Disclaimer: This is not an official Google product._

**Table of Contents**

* [What is the Google Cloud Functions Emulator?](#what-is-the-google-cloud-functions-emulator)

* [How do I get started?](#how-do-i-get-started)

* [Where is the documentation?](#where-is-the-documentation)

  * CLI Docs: `functions --help`

  * [How-To Guides](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/wiki/How-To-Guides)

* [Contributing](#contributing)

* [License](#license)

## What is the Google Cloud Functions Emulator?

The **Google Cloud Functions Emulator** is a Node.js application that implements the Google Cloud Functions API, and includes a CLI with which you can manage the application.

The Emulator allows you to [**deploy**](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/wiki/Deploying-functions), [**run**](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/wiki/Calling-functions), and [**debug**](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/wiki/Debugging-functions) your Cloud Functions on your local machine before deploying them to the production Google Cloud Functions service.

### Note

The Emulator only supports Node `v6.x.x`. It does *not* support Node `v8.x.x` or Python.

## How do I get started?

1. Write a function:

        mkdir helloWorld

        cd helloWorld

        touch index.js

        echo 'exports.helloWorld = (req, res) => res.send("Hello, World!");' > index.js

1. Install the Emulator:

    NPM:

        npm install -g @google-cloud/functions-emulator

    Yarn:

        yarn global add @google-cloud/functions-emulator

    Or read more in the detailed [installation instructions](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/wiki/Installation).

1. Start the Emulator:

        functions start

1. Deploy your function:

        functions deploy helloWorld --trigger-http

    Get help deploying a function with `functions deploy --help`.

1. Call your function:

        functions call helloWorld

1. View the logs:

        functions logs read

## Where is the documentation?

For a quick reference, the Emulator CLI is self-documenting. Run the following to get help with the CLI:

    functions --help

For everything else see the [How-To Guides](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/wiki/How-To-Guides).

## Contributing

To give feedback, report a bug, or request a feature, please [open an issue](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/issues).

To contribute a change, [check out the contributing guide](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/blob/master/.github/CONTRIBUTING.md).

## License

Copyright 2017, Google, Inc.

Licensed under the Apache License, Version 2.0

See the [full license](https://github.com/GoogleCloudPlatform/cloud-functions-emulator/blob/master/LICENSE).