open-toolchain / cloud-functions-nodejs-toolchain

This template has been deprecated and is no longer supported.

Develop a Cloud Functions Node.js application

This repository includes toolchain code to deploy a serverless Backend-for-Frontend (BFF) application that uses Node.js and IBM Cloud Functions. Cloud Functions supplies basic Create, Read, Update, and Delete operations in a serverless environment. These functions can be mapped to an API gateway and then integrated into an iOS app; for example, to enable persistence of data into a Cloudant NoSQL Database or any other NoSQL database.

Included components

• Continuous Delivery: Enable tool integrations that support your development, deployment, and operation tasks.
• GitLab: GitLab unifies issues, code review, CI, and CD into a single UI.

Featured technologies

• IBM Cloud Functions: An event-action platform that allows you to run code in response to an event.
• Node: An open-source JavaScript runtime environment for running server-side JavaScript code.

Steps

While you can use the individual actions locally, this collection of endpoints is meant to be deployed to IBM Cloud Functions. You can deploy this application to IBM Cloud or deploy it manually by cloning this repo first.

You can then review the Actions in the IBM Cloud console, along with your Cloud Functions APIs.

Method	HTTP request	Description
Create	POST /database	Inserts an object
Read	GET /database/objectId	Retrieves an object
ReadAll	GET /database	Retrieves all objects
Delete	DELETE /database/objectId	Deletes an object
DeleteAll	DELETE /database	Deletes all objects
Update	PUT /database/objectId	Updates content of an object

Deploying to IBM Cloud

Click Create toolchain to deploy this same application to IBM Cloud. This option creates a deployment pipeline, complete with a hosted GitLab project and DevOps toolchain. IBM Cloud DevOps services provides toolchains as a set of tool integrations that support development and deployment to IBM Cloud Functions.

Deploying manually

To deploy this application to IBM Cloud using the command line, you can leverage the IBM Cloud Developer Tools.

• Install IBM Cloud Developer Tools on your machine by running the following command:

  curl -sL https://ibm.biz/idt-installer | bash
  

Next steps

• Learn more about augmenting your Node.js applications on IBM Cloud with the Node.js Programming Guide.
• Explore other sample applications on IBM Cloud.

License

Apache 2.0