https://github.com/zowe/explorer-mvs
https://github.com/zowe/explorer-mvs
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zowe/explorer-mvs
- Owner: zowe
- License: epl-2.0
- Created: 2018-08-13T14:39:59.000Z (almost 8 years ago)
- Default Branch: v2.x/master
- Last Pushed: 2024-10-29T14:31:29.000Z (over 1 year ago)
- Last Synced: 2024-10-29T17:22:28.173Z (over 1 year ago)
- Language: JavaScript
- Size: 3.83 MB
- Stars: 0
- Watchers: 12
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# explorer-mvs
[](https://sonarcloud.io/dashboard?id=zowe_explorer-mvs)
The issues for the MVS explorer are tracked under the Zowe Zlux repository, https://github.com/zowe/zlux and tagged accordingly with the 'explorer-mvs' label. Open issues tagged with 'explorer-mvs' can be found [here](https://github.com/zowe/zlux/issues?q=is%3Aissue+is%3Aopen+label%3Aexplorer-mvs).
# App Development Workflow
### Install Dependencies
As following modules
`explorer-ui-server`, `orion-editor-component` and `explorer-fvt-utilities` are published on Zowe Artifactory.
`.npmrc` file is pre-configured with registry value of `https://zowe.jfrog.io/zowe/api/npm/npm-release`
```
npm install
```
### Build for Development
Modify the host variable in WebContent/js/utilities/urlUtils.js to a host and port that has the Zowe API Gateway and Jobs service.
```
npm run dev
```
Then you can visit http://localhost:8080 to test.
When testing you may see errors with API calls do to CORS (Cross origin resource sharing), to work around this you may disable CORS checking in your browser for local development or setup a proxy.
### Run unit tests
```
npm run test
```
### Run fvt/selenium tests
See [README](/tests/FVTTests/README.md)
### Build for Production
```
npm run prod
```
### Prepare PAX Packaging Workspace
```
./.pax/prepare-workspace.sh
```
## Start With explorer-ui-server
After preparing PAX workspace, you can serve the explorer UI with explorer-ui-server:
```
node .pax/ascii/server/src/index.js --config .pax/ascii/server/configs/config.json
```
## Run SonarQube Code Analysis
Install [SonarQube Scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner).
If you are using Mac, try install with [HomeBrew sonar-scanner formula](https://formulae.brew.sh/formula/sonar-scanner), then update the configuration of SonarQube server at `/usr/local/Cellar/sonar-scanner//libexec/conf/sonar-scanner.properties`.
Example scanner configurations:
```
sonar.host.url=https://jayne.zowe.org:9000
sonar.login=
```
Then you can run `sonar-scanner` to start code analysis.
Build pipeline has embedded the SonarQube code analysis stage.
## Build and install as plugin in local zlux development environment
Modify `explorer-mvs/Webcontent/index.html`
Change relative path for `iframe-adapter.js` & `logger.js` to absolute path.
Append with your `API Gateway` `Hostname` and `Port`
For example:
```
```
Build web folder
```
cd explorer-mvs
# root folder
npm install
# This will create web folder
npm run build
```
Install as ZLUX App/Plugin
```
# install in zlux locally
cd zlux/zlux-app-server/bin
./install-app.sh
```
`explorer-mvs` root already have sample `pluginDefinition.json` & will have `web` folder after `build`.
## Enable Redux logs
Either use [Redux Dev Tool Browser Extension](https://github.com/reduxjs/redux-devtools) in your browser
Or enable redux logs by setting `enableReduxLogger` variable `true` in your local storage.
### Add Redux Logger
While explore app is open in browser:
1. Run this in browser console
```
window.localStorage.setItem('enableReduxLogger', true);
```
2. And refresh browser
So as long as this value remains true in browser local storage,
you will see redux logs in console.
### Remove Redux Logger
While explore app is open in browser:
1. Run either `window.localStorage.setItem('enableReduxLogger', false)`
or `window.localStorage.removeItem('enableReduxLogger')`
or clear storage manually in `browser dev tools` under `Application` tab
2. And refresh browser to stop seeing redux console logs.