Skip to content

Github Template that uses TypeScript with Node.js to create a BFF or Microservice API with Open API Specification

License

Notifications You must be signed in to change notification settings

IBM/template-node-typescript

Repository files navigation

IBM Cloud

IBM Cloud platform Apache 2

TypeScript Microservice or Backend for Frontend with Node.js

This Starter Kit Template can be the foundation of a TypeScript Node.js Microservice or Backend for Frontend.

Features

The starter kit provides the following features:

Native Application Development

Install the latest Node.js 18+ LTS version.

After you have created a new git repo from this git template, remember to rename the project. Edit package.json and change the default name to the name you used to create the template.

Once the Node toolchain has been installed, you can download the project dependencies with:

npm ci
npm run build
npm run start

Deploying

Make sure you are logged into the IBM Cloud using the IBM Cloud CLI and have access to your development cluster.

curl -sL https://cli.cloudnativetoolkit.dev/install.sh | sh
ibmcloud login -a cloud.ibm.com -r <region> -g <resource group>
ibmcloud ks cluster-config --cluster <cluster-name>
kubectl get pods

Use the Cloud Native Toolkit CLI to register the GIT Repo with CI environment

oc pipeline 

More Details

For more details on how to use this Starter Kit Template please review the Cloud Native Toolkit Developer Guide

Next Steps

License

This sample application is licensed under the Apache License, Version 2. Separate third-party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 and the Apache License, Version 2.

Apache License FAQ

About

Github Template that uses TypeScript with Node.js to create a BFF or Microservice API with Open API Specification

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published