Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update #67

Merged
merged 8 commits into from
Oct 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/add-a-new-dmp-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Add a new DMP template
about: Please give us recommendation on creating new templates. Any suggestions are
welcoem
title: "[Template Request]"
labels: ''
assignees: ''

---

### Is the target DMP requested by a funding body? If yes, which is it?
Yes, volkswagenstiftung.

### Is the target DMP focuse on a specific domain? If yes, which is it?
Yes, about micro-organisms.

### Is there a guideline or questionnaire? If yes, pleas provide us a link.
https://www.volkswagenstiftung.de/sites/default/files/documents/2022-04%20Basis-Datenmanagementplan.rtf
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]


**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
75 changes: 40 additions & 35 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,40 @@
## introduction
"Data management plan generator" can create a data management plan automatically.
This is a very simple way to make a DMP. By using this Generator, you can create
1. a full Data Management Plan for Horizon Europe and H2020 projects;
2. a full Data Management Plan for DFG projects;
3. a summary for funding proposal;
4. a customized practical guide throughout your projects
5. a user defined template that you can edit freely

[click to test](https://nfdi4plants.github.io/dataplan)


### folder structure:
./js/: javascripts (mainly for style)
./css/: css files (mainly for style)
./docs/: document templates (currently not used, all documents are included in the index.html)
./saved_json/: json files including saved answers.
./index.html : functional javascript codes + all the templates

### usage for document generation:
The "Data management plan generator" is serverless. All functions works even if you disconnect the internet after loading the website.
You could even use "control + S" to save the website and use it for a later time. Just remember that the local cache will be different between the different URLs.

### local storage:
- The answer of the question
- The status of usage (first time visitor or not)
- the user defined template

### Visualization and UI libraries
Thanks to all the open source code gives us inspiration.
The visualization and UI contain code from following project:
UI: [Bootstraps 5](https://getbootstrap.com/)
UI: the introduction tour used [bs5-intro-tour](https://github.com/yaras6/bs5-intro-tour),
Word Cloud Visualization: [d3](https://d3js.org/) and [word cloud](https://github.com/jasondavies/d3-cloud)
File Saving: [FileSaver](https://github.com/eligrey/FileSaver.js/)
# DataPLAN

## Introduction
**DataPLAN** is a user-friendly, serverless Data Management Plan (DMP) generator developed by DataPLANT. It simplifies the creation of DMPs for various projects, including Horizon Europe, H2020, and DFG. This tool can be easily understood by watching this quick [two-minute video](https://www.youtube.com/watch?v=T40Kmah1RTY).

[![Watch the video on YouTube](https://img.youtube.com/vi/T40Kmah1RTY/0.jpg)](https://www.youtube.com/watch?v=T40Kmah1RTY)

## Usage
### Online
- Visit [plan.nfdi4plants.org](https://plan.nfdi4plants.org) to use DataPLAN directly in your browser.

### Offline
1. Download the [zip file](https://github.com/nfdi4plants/dataplan/archive/refs/heads/main.zip).
2. Unzip the file.
3. Open `index.html` in your browser.

## Saving Your Answers
- **Automatic Storage**: Your answers are automatically saved in your browser.
- **Cross-Device Use**: Export and import your answers as JSON files to transfer between browsers or devices.

## Folder Structure
- `/js/`: JavaScript files for functionality and styling.
- `/css/`: Stylesheets for layout and design.
- `/DMPDocs/`: Templates for DMP documents.
- `index.html`: The main file that runs the application.

## Publication
DataPLAN is featured as an issue cover in the journal *Data*:
[![DataPLAN publication](https://nfdi4plants.github.io/dataplan/images/cover.webp)](https://www.mdpi.com/2306-5729/8/11/159)

## License
This project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html).

## Libraries and Tools
DataPLAN leverages several open-source projects:
- **UI**: [Bootstrap 5](https://getbootstrap.com/) and [bs5-intro-tour](https://github.com/yaras6/bs5-intro-tour)
- **Visualization**: [d3.js](https://d3js.org/) and [d3-cloud](https://github.com/jasondavies/d3-cloud)
- **File Handling**: [FileSaver.js](https://github.com/eligrey/FileSaver.js/)

Thanks to these communities for their contributions!