template-node-typescript

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:

• Built with TypeScript
• REST services using typescript-rest decorators
• Swagger documentation using typescript-rest-swagger
• Dependency injection using typescript-ioc decorators
• Logging using bunyan
• TDD environment with Jest
• Pact testing Pact
• Jenkins DevOps pipeline that support OpenShift or IKS deployment

Native Application Development

Install the latest Node.js 6+ 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 install
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.

npm i -g @garage-catalyst/ibm-garage-cloud-cli
ibmcloud login -a cloud.ibm.com -r <region> -g <resource group>
ibmcloud ks cluster-config --cluster <cluster-name>
kubectl get pods
 

Use the IBM Garage for Cloud CLI to register the GIT Repo with Jenkins environment

igc pipeline -n dev

More Details

For more details on how to use this Starter Kit Template please review the IBM Garage for Cloud Developer Tools Developer Guide

Next Steps

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

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