Skip to content
This repository was archived by the owner on Jun 20, 2023. It is now read-only.

CDLUC3/dmp-hub-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dmp-hub-ui

This repository contains the new React interface for the DMPTool.

This project was bootstrapped with Create React App.

Use Cases

See the individual issues in this repo and/or the Trello board

Data Sources

This application uses the DMPHub's API. The API uses a JSON format that is based on the RDA Common Metadata Standard to describe DMP metadata. See the dmp-hub-cfn repository's wiki for the available endpoints, an example of the DMP JSON and explanations of each attribute. If an issue is encountered with the API, please report an issue so that the fix can be tracked and prioritized appropriately.

Infrastructure

This application is hosted in an AWS S3 bucket and served via an AWS Cloudfront distribution. See the dmp-hub-cfn repository For information on these components

An AWS CodePipeline has been created that monitors this repositories main branch. When changes are made, it will trigger the pipeline. The pipeline will use this project's buildspec.yaml file to build the application and deploy the updates to the S3 bucket.

An email of the build results can be emailed. The email will contain the results of npm install and npm run build.

DMPTool API

The DMPTool API that should be used by the React code is hosted by the AWS API Gateway. Documentation of the API can be found on the dmp-hub-cfn repository's wiki. For any issues encountered with the API, please create new tickets on the dmp-hub-cfn issue list.

Use the dmphub-dev.cdlib.org domain when working with the API.

Commands

In the project directory, you can run the following:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may 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.

About

The UI for the DMPHub metadata repository

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors