Skip to main content

Contribute Data

Generate this Task Flow​

cd src/pages
npx degit strudel-science/strudel-kit/src/pages/contribute-data my-contribute-data

File Structure​

contribute-data
├── -components
│  ├── DataFilesPanel.tsx # Data files panel component on the right of the "new" page
│  ├── DatasetView.tsx # Dataset summary panel on the "review" page
│  ├── MetadataPanel.tsx # Metadata panel component on the left of the "new" page
│  └── ValidationChecks.tsx # Validation summary panel on the "review" page
├── -context
│  ├── ContextProvider.tsx # State management for this Task Flow
│  └── actions.ts # Action functions that control the state
├── -tests
│  └── contribute-data.cy.ts # End-to-end test for this Task Flow
├── _layout
│  ├── index.tsx # Initial data registration page
│  ├── new.tsx # Add a new dataset page
│  ├── portal.tsx # Page to show your data uploads
│  └── review.tsx # Page to review a new dataset before upload
└── _layout.tsx # Layout wrapper for the pages

Pages and Layouts​

_layout/index.tsx​

First page of the Contribute Data Task Flow. Displays a user registration form for users that want to contribute datasets.

Customizable items​

  • Register page title
  • Register page description
  • Summary of steps
  • Registration form inputs

_layout/portal.tsx​

User portal page of the Contribute Data Task Flow. Displays a list of the user's current uploaded datasets.

Customizable items​

  • Column definitions for the uploads table
  • Data source for the uploads table
  • Data source ID field
  • Portal page title
  • New dataset button

_layout/new.tsx​

New dataset page of the Contribute Data Task Flow. Displays a metadata form and data upload panel for adding new data contributions.

Customizable items​

  • New dataset page title
  • New dataset page description
  • MetadataPanel.tsx
    • Metadata groups
    • Metadata fields
  • DataFilesPanel.tsx
    • Data source for the files table
    • Data id field for the files table
    • Columns for the files table

_layout/review.tsx​

Review new dataset page of the Contribute Data Task Flow. Displays a preview of the dataset information to be uploaded and mocks standard validation checks on the data.

Customizable items​

  • Review page title
  • DatasetView.tsx
    • Data source for the dataset files table
    • Data ID field for the dataset files table
    • Columns for the dataset files table
    • Dataset title
    • Dataset description
    • Dataset metadata
  • ValidationChecks.tsx
    • Validation panel title
    • Validation panel description