Skip to content

Demonstrates building and running http and pub/sub cloud functions locally

License

Notifications You must be signed in to change notification settings

delineateio/local-cloud-functions-example

Repository files navigation

PRs Welcome Contributors Forks Stargazers Issues MIT License


delineate.io

delineate.io

portray or describe (something) precisely.

Modular Accounts

This is a project for demonstrating working with Cloud Functions locally
Explore the docs »

Report Bug · Request Feature

Table of Contents

About The Project

This project using Python demonstrates the use of Function Framework and the Pub/Sub Emulator for developing Google Cloud Functions.

In this specific example an HTTP service called add_account accepts a message, formats some data and echo's back while raise a pub/sub event that is subscribed to by the add_email_address service which simply print this out.

Built With

Further logos can be inserted to highlight the specific technologies used to create the solution from here.

Syntax Description
pre-commit Pre-commit git hooks that perform checks before pushes
GitHub Source control management platform
Python Implementation of the HTTP and Pub/Sub services

Usage

After the devcontainer starts the following demonstrates the golden path follow of running the cloud functions and testing them.

In addition these services can be debugged is VSCode using the provided launches for debugging.

# starts the emulator
task pubsub:start

# starts the two services
task services:up

# makes a request to the HTTP end point
http POST :8080 'Content-Type: application/json' \
            short_name="Disney" \
            full_name="The Walt Disney Company" \
            code="disn"

# stops the two services
task services:down

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

If you would like to contribute to any delineate.io OSS projects please read:

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

About

Demonstrates building and running http and pub/sub cloud functions locally

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published