https://github.com/irods/irods_testing_environment_ui
A Web Application for iRODS Testing Environment built using React and Node
https://github.com/irods/irods_testing_environment_ui
Last synced: 12 months ago
JSON representation
A Web Application for iRODS Testing Environment built using React and Node
- Host: GitHub
- URL: https://github.com/irods/irods_testing_environment_ui
- Owner: irods
- Created: 2022-06-14T15:13:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-09T14:20:43.000Z (almost 4 years ago)
- Last Synced: 2025-03-04T17:50:46.140Z (over 1 year ago)
- Language: JavaScript
- Size: 345 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# iRODS UI Testing Environment
This repository is a user-friendly, localhost web-app that eases the iRODS Testing Environment
## Needed installations
The application is built using Node and React, therefore having both installed using npm would be ideal. Currently there is no automatic build for local host.
## To get started
After cloning the repository, in the terminal of the repo type the following
```
$ npm install
$ npm start
$ cd client
$ npm install
$ npm start
```
React will prompt you to want to host the web app in a different browser other than 3000, be sure to confirm yes. The server runs on localhost:3000 and is used as a proxy for the React app. Therefore, if you change the port of the server, you MUST change the proxy setting in client/package.json
## Features
Some features for the UI testing environment includes a testing page and a history page.
The Testing Page includes:
- Python test file
- Concurrent containers
- Project directory
- Selecting either package version or package directory
- Verbosity
The Test History Page includes:
- Timestamp of test run
- Basic test information (tests ran, general pass/failure of test, log directory, etc.)
- Ability to read XML test reports and location
## Structure
The structure of the application is made of two larger components. The client folder is the React app. It consists of all the UI components and routing logic.
The second component is server.js that handles all the the requests from the client. Some helpeer functions are defined in test_helpers.mjs to help complete certain requests.
Note: any changes made in the client while the application is running will rerender the application automatically on save. Any changes outside of the client directory will require you to restart the server.