This repository provides a simple starting point for running TypeScript applications on OpenShift. It can also be applied to applications that use Babel or other transpilers.
A blogpost that runs through the details of this repository and OpenShift can be found here.
You can use this repository as a template, just click the green "Use this template" button at the top of this page on GitHub.
To use this method of deployment you'll need:
- Node.js v12 or later
- OpenShift 4.x (Run OpenShift 4.x locally using CodeReady Containers)
NodeShift is a neat CLI that simplifies deployment of Node.js applications on
OpenShift. This project incldues NodeShift in devDependencies.
You can run the following to deploy it on an OpenShift instance:
$ git clone git@github.com:evanshortiss/openshift-typescript-example.git ts-openshift
$ cd ts-openshift
# Ensure you are logged into your openshift instance
$ oc login
# Choose the project you'd like to deploy this applicaion into
$ oc new-project ts-example
# Build, deploy, and expose an endpoint for the service
$ npm run nodeshift -- --expose
If you're deploying on a locally running instance of OpenShift you might need to do the following to bypass the self-signed certificate issues:
$ npm run nodeshift -- --expose --strictSSL=false
To run this application locally you'll need:
- Node.js v12 or later
- npm v6 or later
- Git
Execute the following commands to start the program locally:
git clone git@github.com:evanshortiss/openshift-typescript-example.git ts-openshift
cd ts-openshift
npm instal
npm run build
npm start
If you're developing locally, start a live reload server like so:
npm run start-dev
To perform the following steps you'll need:
With both tools installed, execute the following commands to run your application locally. This will create a container that matches the one created using an OpenShift Build.
# Run the s2i build script ./scripts/s2i.sh # Run the container image docker run -p 8080:8080 quay.io/evanshortiss/openshift-s2i-typescript-example
To perform the following steps you'll need:
- Docker (v19.x tested)
- Docker Compose
Run the docker-compose up command from the root of the repository to start
Node.js and Redis containers.
The application will be available on port 8080.