Skip to content

Latest commit

 

History

History
131 lines (76 loc) · 6.71 KB

README.md

File metadata and controls

131 lines (76 loc) · 6.71 KB
Raw

CircleCI Node CI

Introduction

This project:

  • was bootstrapped with Create React App.
  • was forked from original source to further be used as template for developments (like libhacontimig)
  • was ajusted to include integration with technologies (like Terraform, Ansible, Kubernetes), mentioned in github topics and can be learned about in README.md files within folders. For more details, see https://github.com/HolimaX/React/blob/<branch>/src/README.md file as one of such inclusives.

React-based Application is still kept isolated to ensure overall integrity and transaprency.

Application Prerequistes

You can establish environment in many ways. For example:

  • In order for this React app to be started, the valid Okta connection is needed.

Configuration is set up during registration phase from connected Cloud Dashboard tools (like Android Phone app).

  • In order for this React app to be served w/o 'serve' tool, you need to install either Apache or NGNIX (but not both!) within non-control-plane (Master) node.

Then, production build via npm build must be made and serving can be executed.

Available Scripts

  • In the project ./.jenkinsci directory, you can use Jenkins(file) to execute complete deployment process to AWS. The step(s) assumes that the AWS AMI and AWS Launch Template is created and available un your AWS account.

  • In the project ./. (root) directrory, you can run terraform commands to individually create AWS resources. The step(s) assumes the terraform is installed and available in the PATH. For adjsutments, configuration files are stored in ./.terraformconfig .

  • In the project ./. (root) directrory, you can run ansible commands to individually create AWS resources. The step(s) assumes the ansible is installed and available in the PATH. For adjsutments, configuration files are stored in ./.ansibleconfig .

  • In the project ./. (root) directrory, you can run kubectl commands to individually create AWS resources. The step(s) assumes the kubectl is installed and available in the PATH. For adjsutments, configuration files are stored in ./.k8sconfig .

  • In the project ./. (root) directory, you can run (assuming nodejs, npm and yarn is installed and available in the PATH):

npm start

Runs the app in the development mode.
Open http://localhost:3010 to view it in the browser. Ensure PORT 3001 is accessible to support additional features.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Authentication

For compatible Products with designated type (like "Pro"/"Premium"):

  • Release 1 supports OAuth 2.0 based authentication, as explained in OAuth2

  • Release 3 supports ES6 Class-based component loading via optionalDependencies and rendering check via ComponentDidMount() React Lifecycle methods with compatible SPAs.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: splitting

Analyzing the Bundle Size

This section has moved here: size

Making a Progressive Web App

This section has moved here: PWA

Advanced Configuration

This section has moved here: advanced

Deployment

This section has moved here: deployment

npm run build fails to minify

This section has moved here: minify

Integrations

To use Node REPL and see available functionality, you can execute following command: node beerbank

Internal (REST API based) integrations

You can use internal REST API based logic for incoming calls handling for Infrastructure integrated applications. The logic consits of Auto-Synchronization, Auto-Notification and Auto-Configuration management for Pro ("Premium") modules.

Also, The supported method for advanced integration is via C-style header SO libraries. See Integration via GoLang for details.

Note: Only CircleCI is building the header files.

As of now, the infrastructure automation (kubernetes pod) configuration is adjusted in case there is incoming function call from integrated applications. This implementation is not aimed to 'push' changes, but 'pull' instead.