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

Commit

Permalink
editorial and branding
Browse files Browse the repository at this point in the history
  • Loading branch information
van-ibm committed Jun 20, 2018
1 parent 527046a commit 95f3d5c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 17 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
# Logistics Wizard Web User Interface

| **master** | [![Build Status](https://travis-ci.org/IBM-Cloud/logistics-wizard-webui.svg?branch=master)](https://travis-ci.org/IBM-Cloud/logistics-wizard-webui) [![Coverage Status](https://coveralls.io/repos/github/IBM-Cloud/logistics-wizard-webui/badge.svg?branch=master)](https://coveralls.io/github/IBM-Cloud/logistics-wizard-webui?branch=master) |
| ----- | ----- |
| **dev** | [![Build Status](https://travis-ci.org/IBM-Cloud/logistics-wizard-webui.svg?branch=dev)](https://travis-ci.org/IBM-Cloud/logistics-wizard-webui) [![Coverage Status](https://coveralls.io/repos/github/IBM-Cloud/logistics-wizard-webui/badge.svg?branch=dev)](https://coveralls.io/github/IBM-Cloud/logistics-wizard-webui?branch=dev)|
<a href="https://www.zenhub.com/"><img src="https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png"></a>

This project is part of the larger [Logistics Wizard](https://github.com/IBM-Cloud/logistics-wizard) project.
Logistics Wizard](https://github.com/IBM-Cloud/logistics-wizard/tree/master#logistics-wizard-overview) / [Architecture](https://github.com/IBM-Cloud/logistics-wizard/tree/master#architecture) / logistics-wizard-webui

## Overview
# Logistics Wizard Web User Interface

This project is designed with a bunch of awesome new front-end technologies, all on top of a configurable, feature-rich webpack build system that's already setup to provide hot reloading, CSS modules with Sass support, unit testing, code coverage reports, bundle splitting, and a whole lot more, while providing amazing developer tools such as Redux CLI (a generator), Redux devtools (Chrome extension), and Storybook for visually developing and testing components.

Expand All @@ -16,7 +9,7 @@ This is meant to be a client-side static file application only. No server is use

## Running the WEBUI locally

When the application runs locally, it uses a Node.js server to bring you developer tools like hot swap. **When deployed to Cloud, Node.js runtime is NOT used.** We will build static files to the `dist` folder and use nginx to host those static files as a purely client side application. Do not write any server side code in this application.
When the application runs locally, it uses a Node.js server to bring you developer tools like hot swap. **When deployed to cloud, a Node.js runtime is NOT used.** You will build static files to the `dist` folder and use nginx to host those static files as a purely client side application. Do not write any server side code in this application.

#### Get the code
```
Expand All @@ -36,9 +29,9 @@ module.exports = {

## Deploy the WEBUI to IBM Cloud - Cloud Foundry

To use a continous integration pipeline to handle build and deployment, go here: https://github.com/IBM-Cloud/logistics-wizard-toolchain. To manually push to Cloud, continue:
To use a continous integration pipeline to handle build and deployment, visit https://github.com/IBM-Cloud/logistics-wizard-toolchain. To manually push to IBM Cloud, continue.

We need to compile/build the application to generate static web files. Then push only those static files to Cloud and use the nginx buildpack to host the files
You need to compile and build the application to generate static web files. Then push only those static files to Cloud and use the nginx buildpack to host the files

Verify that your `config/.env` file has the correct controller service URL. This URL will be read and injected to the static files during the build process.
```
Expand All @@ -47,13 +40,25 @@ npm run deploy:prod
cd dist
```

Test to see if your built application is working OK:
Test to see if your application is working.

```
npm install http-server -g
http-server
```
Application should be available at http://127.0.0.1:8080 . If everything looks OK, push it to IBM Cloud

The application should be available at http://127.0.0.1:8080 . If everything looks OK, push it to IBM Cloud
```
bx cf push <unique-app-name> -b staticfile_buildpack
ibmcloud app push <unique-app-name> -b staticfile_buildpack
```

## License

See [License.txt](License.txt) for license information.

## Status

| **master** | [![Build Status](https://travis-ci.org/IBM-Cloud/logistics-wizard-webui.svg?branch=master)](https://travis-ci.org/IBM-Cloud/logistics-wizard-webui) [![Coverage Status](https://coveralls.io/repos/github/IBM-Cloud/logistics-wizard-webui/badge.svg?branch=master)](https://coveralls.io/github/IBM-Cloud/logistics-wizard-webui?branch=master) |
| ----- | ----- |
| **dev** | [![Build Status](https://travis-ci.org/IBM-Cloud/logistics-wizard-webui.svg?branch=dev)](https://travis-ci.org/IBM-Cloud/logistics-wizard-webui) [![Coverage Status](https://coveralls.io/repos/github/IBM-Cloud/logistics-wizard-webui/badge.svg?branch=dev)](https://coveralls.io/github/IBM-Cloud/logistics-wizard-webui?branch=dev)|
<a href="https://www.zenhub.com/"><img src="https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png"></a>
4 changes: 2 additions & 2 deletions README_react.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ Out of the box, this project is deployable by serving the `~/dist` folder genera
### Static Deployments
Whether you are serving the application via node or a web server such as nginx, make sure to direct incoming routes to the root `~/dist/index.html` file and let react-router take care of the rest. The Koa server that is being used as the dev server can be extended to host the app and serve as an API or whatever else you need, but that's entirely up to you.

### Bluemix
We use the staticfile_buildpack to deploy the client to Bluemix with an nginx web server. In order to override the default nginx.conf provided by the buildpack, we simply copied the provided config from the buildpack repo and added the try_files directive:
### IBM Cloud
We use the staticfile_buildpack to deploy the client to IBM Cloud with an nginx web server. In order to override the default nginx.conf provided by the buildpack, we simply copied the provided config from the buildpack repo and added the try_files directive:
```
...
location / {
Expand Down

0 comments on commit 95f3d5c

Please sign in to comment.