Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nasa-pds/doi-ui
The web interface for the PDS DOI Service providing the ability management PDS archive DOIs. See the DOI Service for more details on the available capabilities. https://nasa-pds.github.io/doi-service/
https://github.com/nasa-pds/doi-ui
doi nasa nasa-pds pds
Last synced: about 1 month ago
JSON representation
The web interface for the PDS DOI Service providing the ability management PDS archive DOIs. See the DOI Service for more details on the available capabilities. https://nasa-pds.github.io/doi-service/
- Host: GitHub
- URL: https://github.com/nasa-pds/doi-ui
- Owner: NASA-PDS
- License: apache-2.0
- Created: 2020-09-17T23:07:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-30T15:51:36.000Z (7 months ago)
- Last Synced: 2024-05-30T18:48:45.783Z (7 months ago)
- Topics: doi, nasa, nasa-pds, pds
- Language: JavaScript
- Homepage:
- Size: 6.25 MB
- Stars: 0
- Watchers: 9
- Forks: 4
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# pds-doi-ui
Front-end interface for pds-doi-service
An example for the reservation excel input file can be found at https://pds-engineering.jpl.nasa.gov/user/login?destination=node/691
## Pre-requisites
### Install the pds-doi-service:
```
pip install pds-doi-service
pds-doi-api
```
See https://nasa-pds.github.io/doi-service/ for details
### Node Installation
The doi-ui app relies on a specific version of [NodeJS](https://nodejs.org/en). Ensure the NodeJS version specified in the `.nvmrc` file, located at the root of the repository is installed.
We recommend the use of the [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm) to easily facilitate the installation and switching between node versions. After following the `nvm` installation instructions and navigating to the location this repo is cloned on your machine, you can use the following commands to manage the version of node used for this project:
#### Install the node version specified in .nvmrc if it isn't already installed
nvm install
#### Switch to the node version specified in .nvmrc for all commands in the current shell window
nvm use
## To Run And Build Locally
### Run `npm install`
This will install all necessary dependencies.
### Change API Locations In The Config File
The config file is located at: `public/config.js` It contains the necessary HTTP request URLs for the application to function correctly. These must be changed to point to your deployed backend server.
### Update the Authentication Related Configurations
You can set these configurations also in the `public/config.js`. Make sure to use correct URL paths to match with your environment. You may check with the system admins to get the Amazon Cognito related values.
```js
window['getGlobalConfig'] = {
api: 'http://localhost:8080/PDS_APIs/pds_doi_api/0.2/',
oauth_client_id: '',
oauth_redirect_uri: 'http://localhost:3000',
oauth_logout_endpoint: 'https://.auth.us-west-2.amazoncognito.com/logout',
oauth_provider_url: 'https://.auth.us-west-2.amazoncognito.com/oauth2',
app_viewer_group_name: 'PDS_Viewer',
app_admin_group_name: 'PDS_Admin',
}
```
### Run `npm start`
Runs the app in development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
### Run `npm run build`
Builds the app into deployable files in the `/build` directory.
These files can be put into any server to run the app.
#### Create a release
git tag
git push --tags
npm run build
mv build pds-doi-ui-
zip -r pds-doi-ui.zip pds-doi-ui-
Upload the zip file in the release of the tag in github
## For Administrator
### Deploying A Stable Release
#### Clone Build Files
```
git clone https://github.com/NASA-PDS/pds-doi-ui.git
cd pds-doi-ui
git checkout
npm install -g serve
serve -s build
```
#### Run from build archive
From the github release page https://github.com/NASA-PDS/pds-doi-ui/releases/
Select the latest version and download the zip file in assets `pds-doi-ui.zip`
Unzip and start a standalone server
```
serve -s pds-doi-ui
```
The unzipped directory can also be configured to be published by an **apache** or **nginx** server.
**Troubleshooting:** a serve command is also available in anaconda, be careful not to use it instead of the npm serve.
### SSH Tunnel to DOI Service
```
ssh -L 8085:localhost:8080
```