Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/binnes/stockbbfnode-bi
https://github.com/binnes/stockbbfnode-bi
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/binnes/stockbbfnode-bi
- Owner: binnes
- License: apache-2.0
- Created: 2020-10-28T10:28:09.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-28T12:08:28.000Z (about 4 years ago)
- Last Synced: 2023-03-03T10:46:12.855Z (almost 2 years ago)
- Language: TypeScript
- Size: 191 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://www.typescriptlang.org/)
- 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](https://jestjs.io/)
- Pact testing [Pact](https://docs.pact.io/)
- Jenkins DevOps pipeline that support OpenShift or IKS deployment
#### Native Application Development
Install the latest [Node.js](https://nodejs.org/en/download/) 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:
```bash
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.
```$bash
npm i -g @garage-catalyst/ibm-garage-cloud-cli
ibmcloud login -a cloud.ibm.com -r -g
ibmcloud ks cluster-config --cluster
kubectl get pods
```
Use the IBM Garage for Cloud CLI to register the GIT Repo with Jenkins environment
```$bash
oc sync --dev
oc pipeline
```
## More Details
For more details on how to use this Starter Kit Template please review the [IBM Garage for Cloud Developer Tools Developer Guide](https://ibm-garage-cloud.github.io/ibm-garage-developer-guide/)
## Next Steps
* Learn more about augmenting your Node.js applications on IBM Cloud with the [Node Programming Guide](https://cloud.ibm.com/docs/node?topic=nodejs-getting-started).
## 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](https://developercertificate.org/) and the [Apache License, Version 2](https://www.apache.org/licenses/LICENSE-2.0.txt).
[Apache License FAQ](https://www.apache.org/foundation/license-faq.html#WhatDoesItMEAN)