Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Commit 3f935cd

Browse files
author
Rizchel Dayao
committed
Updating README.md
1 parent c3ef3d9 commit 3f935cd

File tree

3 files changed

+151
-1
lines changed

3 files changed

+151
-1
lines changed

MAINTAINERS.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Maintainers Guide
2+
3+
This guide is intended for maintainers - anybody with commit access to one or
4+
more Code Pattern repositories.
5+
6+
## Methodology
7+
8+
This repository does not have a traditional release management cycle, but
9+
should instead be maintained as as a useful, working, and polished reference at
10+
all times. While all work can therefore be focused on the master branch, the
11+
quality of this branch should never be compromised.
12+
13+
The remainder of this document details how to merge pull requests to the
14+
repositories.
15+
16+
## Merge approval
17+
18+
The project maintainers use LGTM (Looks Good To Me) in comments on the pull
19+
request to indicate acceptance prior to merging. A change requires LGTMs from
20+
two project maintainers. If the code is written by a maintainer, the change
21+
only requires one additional LGTM.
22+
23+
## Reviewing Pull Requests
24+
25+
We recommend reviewing pull requests directly within GitHub. This allows a
26+
public commentary on changes, providing transparency for all users. When
27+
providing feedback be civil, courteous, and kind. Disagreement is fine, so long
28+
as the discourse is carried out politely. If we see a record of uncivil or
29+
abusive comments, we will revoke your commit privileges and invite you to leave
30+
the project.
31+
32+
During your review, consider the following points:
33+
34+
### Does the change have positive impact?
35+
36+
Some proposed changes may not represent a positive impact to the project. Ask
37+
whether or not the change will make understanding the code easier, or if it
38+
could simply be a personal preference on the part of the author (see
39+
[bikeshedding](https://en.wiktionary.org/wiki/bikeshedding)).
40+
41+
Pull requests that do not have a clear positive impact should be closed without
42+
merging.
43+
44+
### Do the changes make sense?
45+
46+
If you do not understand what the changes are or what they accomplish, ask the
47+
author for clarification. Ask the author to add comments and/or clarify test
48+
case names to make the intentions clear.
49+
50+
At times, such clarification will reveal that the author may not be using the
51+
code correctly, or is unaware of features that accommodate their needs. If you
52+
feel this is the case, work up a code sample that would address the pull
53+
request for them, and feel free to close the pull request once they confirm.
54+
55+
### Does the change introduce a new feature?
56+
57+
For any given pull request, ask yourself "is this a new feature?" If so, does
58+
the pull request (or associated issue) contain narrative indicating the need
59+
for the feature? If not, ask them to provide that information.
60+
61+
Are new unit tests in place that test all new behaviors introduced? If not, do
62+
not merge the feature until they are! Is documentation in place for the new
63+
feature? (See the documentation guidelines). If not do not merge the feature
64+
until it is! Is the feature necessary for general use cases? Try and keep the
65+
scope of any given component narrow. If a proposed feature does not fit that
66+
scope, recommend to the user that they maintain the feature on their own, and
67+
close the request. You may also recommend that they see if the feature gains
68+
traction among other users, and suggest they re-submit when they can show such
69+
support.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# React-redux-api-example
1+
# Movie Finder
22

33
This project calls the OMDb API to get information about a movie the user entered using React and Redux.
44

README1.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Deploy a React application on Kubernetes
2+
3+
In this Code Pattern, we will deploy a React application using Kubernetes.
4+
5+
There are many choices when looking for the right solution to manage and deploy our applications. It can often be overwhelming when we're trying to pick the right solution. One of our many choices is Kubernetes. This pattern will take you through how to get a front end application deployed on Kubernetes. After implementing the code, you will have the knowledge to deploy your own applications on Kubernetes.
6+
7+
This repository uses the React JavaScript library to build out the front end of the application. Redux is a predictable state container used hand in hand with React. The OMDb API is used to get movie information based on user input. It handles all of the state management within the application. Docker is an open source tool that is used to package the application into a container. Kubernetes handles the management and deployment of the containerized application.
8+
9+
When the reader has completed this Code Pattern, they will understand how to:
10+
* Containerize a React application using Docker
11+
* Deploy and manage an application using Kubernetes
12+
13+
## Flow
14+
15+
## Included components
16+
* IBM Cloud Container Service: IBM Bluemix Container Service manages highly available apps inside Docker containers and Kubernetes clusters on the IBM Cloud.
17+
* Kubernetes Cluster: Create and manage your own cloud infrastructure and use Kubernetes as your container orchestration engine.
18+
19+
## Featured technologies
20+
* Node.js: An open-source JavaScript run-time environment for executing server-side JavaScript code.
21+
* Cloud: Accessing computer and information technology resources through the Internet.
22+
* Containers: Virtual software objects that include all the elements that an app needs to run.
23+
* Container Orchestration: Automating the deployment, scaling and management of containerized applications.
24+
25+
# Watch the video
26+
27+
# Steps
28+
Use the ``Deploy to IBM Cloud`` button **OR** run locally.
29+
30+
## Run locally
31+
> NOTE: These steps are only needed when running locally instead of using the ``Deploy to IBM Cloud`` button.
32+
33+
1. [Clone the repo](#1-clone-the-repo)
34+
2. [Retrieve an api key for OMDb API](#2-retrieve-an-api-key-for-omdb-api)
35+
3. [Containerize the application using Docker](#3-containerize-the-application-using-docker)
36+
4. [Deploy the application on Kubernetes](#3-deploy-the-application-on-kubernetes)
37+
38+
### 1. Clone the repo
39+
40+
Clone the `react-redux-api-example` locally. In a terminal, run:
41+
42+
```
43+
$ git clone https://github.com/rizcheldayao/react-redux-api-example.git
44+
```
45+
46+
### 2. Retrieve an auth key for OMDb API
47+
48+
You must get an API key from http://www.omdbapi.com/ in order to get a response from the API. You will insert your API key in /src/actions/index.js on line 42
49+
50+
### 3. Containerize the application using Docker
51+
52+
In a terminal, run the following commands:
53+
54+
```
55+
$ docker build -t <your_docker_username>/react-redux-api-example .
56+
```
57+
58+
```
59+
$ docker run -p 3000:3000 -d <your_docker_username>/react-redux-api-example
60+
```
61+
62+
### 4. Deploy the application on Kubernetes
63+
64+
In a terminal, run the following commands:
65+
66+
```
67+
$ bx cr namespace-add <your_namespace>
68+
```
69+
70+
```
71+
$ bx cr build -t registry.<region>.bluemix.net/<your_namespace>/react-redux-api-example:v1 .
72+
```
73+
74+
```
75+
$ docker tag react-redux-api-example registry.<region>.bluemix.net/<your_namespace>/react-redux-api-example:v2
76+
```
77+
78+
```
79+
$ docker push registry.<region>.bluemix.net/<your_namespace>/react-redux-api-example:v2
80+
```
81+

0 commit comments

Comments
 (0)