https://github.com/rampadc/cntk-react-ui
CNTK React UI
https://github.com/rampadc/cntk-react-ui
Last synced: 4 months ago
JSON representation
CNTK React UI
- Host: GitHub
- URL: https://github.com/rampadc/cntk-react-ui
- Owner: rampadc
- License: apache-2.0
- Created: 2020-05-25T05:13:07.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-10T22:42:33.000Z (over 3 years ago)
- Last Synced: 2025-01-23T05:24:42.057Z (5 months ago)
- Language: JavaScript
- Size: 1.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React UI Patterns with Node.js
React is a popular framework for creating user interfaces in modular components. In this sample application, you will create a web application using Express and React to serve web pages in Node.js, complete with standard best practices, including a health check and application metric monitoring.
This code pattern contains 12 popular UI patterns that make it very easy to construct a dashboard application.
This app contains an opinionated set of components for modern web development, including:
* [React](https://facebook.github.io/react/)
* [Webpack](https://webpack.github.io/)
* [Sass](http://sass-lang.com/)
* [gulp](http://gulpjs.com/)
* [Carbon](https://www.carbondesignsystem.com/)
### Deploying
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.
Make sure you are logged into the IBM Cloud using the IBM Cloud CLI and have access
to you development cluster. If you are using OpenShift make sure you have logged into OpenShift CLI on the command line.
```$bash
npm i -g @garage-catalyst/ibm-garage-cloud-cli
```
Use the IBM Garage for Cloud CLI to register the GIT Repo with Jenkins
```$bash
igc register
```
### Building Locally
To get started building this application locally, you can either run the application natively or use the [IBM Cloud Developer Tools](https://cloud.ibm.com/docs/cli?topic=cloud-cli-getting-started) for containerization and easy deployment to IBM Cloud.
#### Native Application Development
Install the latest [Node.js](https://nodejs.org/en/download/) 6+ LTS version.
Once the Node toolchain has been installed, you can download the project dependencies with:
```bash
npm install
cd client; npm install; cd ..
npm run build
npm run start
```
Modern web applications require a compilation step to prepare your ES2015 JavaScript or Sass stylesheets into compressed Javascript ready for a browser. Webpack is used for bundling your JavaScript sources and styles into a `bundle.js` file that your `index.html` file can import.
***Webpack***
For development mode, use `webpack -d` to leave the sources uncompress and with the symbols intact.
For production mode, use `webpack -p` to compress and obfuscate your sources for development usage.
***Gulp***
Gulp is a task runner for JavaScript. You can run the above Webpack commands in by running:
```bash
gulp
```
To run your application locally:
```bash
npm run start
```
Your application will be running at `http://localhost:3000`. You can access the `/health` and `/appmetrics-dash` endpoints at the host.
##### Session Store
You may see this warning when running `ibmcloud dev run`:
```
Warning: connect.session() MemoryStore is not
designed for a production environment, as it will leak
memory, and will not scale past a single process.
```
When deploying to production, it is best practice to configure sessions to be stored in an external persistence service.
## 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).
* Explore other [sample applications](https://cloud.ibm.com/developer/appservice/starter-kits) on IBM Cloud.
## 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)