Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evanshortiss/openshift-typescript-example
A sample TypeScript application that can be deployed on OpenShift
https://github.com/evanshortiss/openshift-typescript-example
javascript kubernetes nodejs okd openshift openshift-io openshift-origin ts typescript
Last synced: 4 days ago
JSON representation
A sample TypeScript application that can be deployed on OpenShift
- Host: GitHub
- URL: https://github.com/evanshortiss/openshift-typescript-example
- Owner: evanshortiss
- Created: 2018-01-23T06:14:34.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-11T15:40:45.000Z (over 3 years ago)
- Last Synced: 2024-11-02T11:11:43.797Z (11 days ago)
- Topics: javascript, kubernetes, nodejs, okd, openshift, openshift-io, openshift-origin, ts, typescript
- Language: TypeScript
- Size: 46.9 KB
- Stars: 8
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TypeScript Sample Application
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](http://evanshortiss.com/development/openshift/javascript/typescript/2018/02/15/ts-on-openshift.html).
You can use this repository as a template, just click the green "Use this
template" button at the top of this page on GitHub.
## Running on OpenShift via NodeShift
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](https://developers.redhat.com/products/codeready-containers/overview))
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 [email protected]: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
```
## Run Locally without Docker
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 [email protected]: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
```
## Build Locally using Source-to-Image (s2i)
To perform the following steps you'll need:
* [Docker](https://docs.docker.com/release-notes/) (v19.x tested)
* [s2i](https://github.com/openshift/source-to-image/releases) (v1.1.13 tested)
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.
```bash
# Run the s2i build script
./scripts/s2i.sh
# Run the container image
docker run -p 8080:8080 quay.io/evanshortiss/openshift-s2i-typescript-example
```
## Running Local Dev Mode using Docker Compose
To perform the following steps you'll need:
* [Docker](https://docs.docker.com/release-notes/) (v19.x tested)
* [Docker Compose](https://docs.docker.com/compose/install/)
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.