https://github.com/mdietrichstein/digitalpreservation-dmp-generator
Automatic DMP Generator
https://github.com/mdietrichstein/digitalpreservation-dmp-generator
datamanagement datascience digitalpreservation dmp doi github orcid zenodo
Last synced: 2 months ago
JSON representation
Automatic DMP Generator
- Host: GitHub
- URL: https://github.com/mdietrichstein/digitalpreservation-dmp-generator
- Owner: mdietrichstein
- License: mit
- Created: 2018-04-19T10:40:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-26T12:46:54.000Z (over 7 years ago)
- Last Synced: 2025-08-01T07:20:06.637Z (2 months ago)
- Topics: datamanagement, datascience, digitalpreservation, dmp, doi, github, orcid, zenodo
- Language: JavaScript
- Size: 638 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Digital Preservation - DMP Generator
## How to run
1. Check out project
2. Run `./gradlew clean eclipse` in terminal
3. In Eclipse: `File -> Import -> General -> Existing Projects into Workspace` and choose the root folder of this repository
4. In Eclipse: Find `DmpGeneratorApplication.java` and right-click then `Run As -> Java Application`
The webapp should now run at `http://localhost:8080`
## Web Resources
Html/Css/Javascript files are located at `src/main/resources/static`
## API Endpoints
The following API endpoints are implemented:
**Orcid Search**
`http://localhost:8080/orcid/search?q=Marc%20Dietrichstein`
**Orcid Profile Retrieval**
`http://localhost:8080/orcid/profile/0000-0003-4890-3498`
**Zenodo Metdata Retrieval**
`http://localhost:8080/oai_pmh/record/?identifier=10.5281/zenodo.1209833&type=doi`
**Github Repository Info**
`http://localhost:8080/github/owner/mdietrichstein/repository/digitalpreservation-dmp`
or
`http://localhost:8080/github/owner/mdietrichstein/repository/digitalpreservation-dmp?ref=1.0.0`
## Docker
1. Build a docker image: `./gradlew build docker`
2. Run it: `docker run -p 8080:8080 at.ac.tuwien.digital_preservation_2018.group2_4.fair/dmp-generator`
3. Open `http://localhost:8080` in your browser
The Github API might stop working due to limitations on their unauthenticated API access.
To force the app to use authenticated Github API requests you have to set the `GITHUB_USERNAME` and `GITHUB_PASSWORD` environment variables:
```docker run -e GITHUB_USER='YOUR_GH_USER' -e GITHUB_PASSWORD='YOUR_GH_PW' -p 8080:8080 at.ac.tuwien.digital_preservation_2018.group2_4.fair/dmp-generator```