globus-mrdp-dynamic

Dynamic buildout of static data portal

https://github.com/navyashr4/globus-mrdp-dynamic

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Dynamic buildout of static data portal

Basic Info
  • Host: GitHub
  • Owner: Navyashr4
  • License: apache-2.0
  • Language: TypeScript
  • Default Branch: main
  • Size: 2.29 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 5
  • Releases: 0
Created about 1 year ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Citation

README.md

static-data-portal

🧪 BETA 🧪

This is a Globus-powered research data portal generator created using Next.js.


⚠️ IMPORTANT ⚠️ You only need to interact with this repository if you are improving the generator or using this code to start a self-managed project. If you want to deploy a data portal, copy our template-data-portal and modify the static.json file to suit your needs.



This is a Next.js project bootstrapped with create-next-app.

Developer Documentation

static.json

  • The static.json file is the main configuration file for the data portal.
  • The utils/static.ts file is used to enforce a TypeScript type on this file.
  • All pages and components that source information from the user-provided static.json should use utils/static.ts and its available helpers.
  • Typedoc is configured to generate documentation from utils/static.ts.

The included static.json in this repository is configured toward local development, using a non-production Globus environment (sandbox).

MDX Support

MDX support has been added to the project.

For simple pages, e.g. "Terms and Conditions" and "Privacy Policy" .mdx is used to simplify these files being overwritten by end consumers using a overrides or content directory.

content Directory

An end-user provided content directory can be defined to provide Markdown (or MDX) files that will be added as pages in the Next.js project. This allows for the end-user to provide custom pages without modifying the core project (via overrides). This also allows us to provide backwards compatibility should we decide to move away from Next.js in the future.

Owner

  • Login: Navyashr4
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
authors:
- family-names: "Bottigliero"
  given-names: "Joe"
  orcid: "https://orcid.org/0009-0009-9663-0050"
title: "Static Data Portal"
version: 1.3.0
date-released: 2024-03-14
url: "https://github.com/globus/static-data-portal"

GitHub Events

Total
  • Delete event: 15
  • Issue comment event: 13
  • Push event: 13
  • Pull request event: 32
  • Fork event: 1
  • Create event: 21
Last Year
  • Delete event: 15
  • Issue comment event: 13
  • Push event: 13
  • Pull request event: 32
  • Fork event: 1
  • Create event: 21

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 21
  • Average time to close issues: N/A
  • Average time to close pull requests: 11 days
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.57
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 21
Past Year
  • Issues: 0
  • Pull requests: 21
  • Average time to close issues: N/A
  • Average time to close pull requests: 11 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.57
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 21
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (21)
Top Labels
Issue Labels
Pull Request Labels
dependencies (21) javascript (3)

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • actions/setup-node v4 composite
.github/workflows/playwright.yml actions
  • actions/checkout v4 composite
  • actions/setup-node v4 composite
  • actions/upload-artifact v4 composite
.github/workflows/release-please.yml actions
  • actions/checkout v4 composite
  • actions/setup-node v4 composite
  • googleapis/release-please-action v4 composite
.github/workflows/static.yml actions
package-lock.json npm
  • 872 dependencies
package.json npm
  • @globus/types ^0.0.7 development
  • @heroicons/react ^2.2.0 development
  • @jest/globals ^29.7.0 development
  • @playwright/test ^1.49.1 development
  • @tanstack/eslint-plugin-query ^5.62.16 development
  • @testing-library/jest-dom ^6.6.3 development
  • @testing-library/react ^16.1.0 development
  • @testing-library/user-event ^14.5.2 development
  • @types/node ^22 development
  • @types/react ^18 development
  • @types/react-dom ^18 development
  • @typescript-eslint/eslint-plugin ^8.19.1 development
  • @typescript-eslint/parser ^8.19.1 development
  • dotenv ^16.4.5 development
  • eslint ^8.57.1 development
  • eslint-config-next 14.2.15 development
  • eslint-config-prettier ^9.1.0 development
  • eslint-config-standard ^17.1.0 development
  • eslint-config-standard-jsx ^11.0.0 development
  • eslint-config-standard-react ^13.0.0 development
  • eslint-plugin-import ^2.31.0 development
  • eslint-plugin-jsx-a11y ^6.10.2 development
  • eslint-plugin-node ^11.1.0 development
  • eslint-plugin-prettier ^5.2.1 development
  • eslint-plugin-promise ^6.6.0 development
  • eslint-plugin-react ^7.37.2 development
  • eslint-plugin-react-hooks ^4.6.2 development
  • glob ^11.0.1 development
  • jest ^29.7.0 development
  • jest-environment-jsdom ^29.7.0 development
  • prettier 3.4.2 development
  • ts-node ^10.9.2 development
  • typedoc ^0.27.6 development
  • typedoc-plugin-markdown ^4.4.1 development
  • typedoc-plugin-missing-exports ^3.1.0 development
  • typescript ^5 development
  • @chakra-ui/icons ^2.2.4
  • @chakra-ui/next-js ^2.4.2
  • @chakra-ui/react ^2.10.5
  • @emotion/react ^11.14.0
  • @emotion/styled ^11.14.0
  • @globus/react-auth-context ^0.0.9
  • @globus/sdk 5.4.1
  • @mdx-js/loader ^3.1.0
  • @mdx-js/react ^3.1.0
  • @next/mdx ^14.2.23
  • @tanstack/react-query ^5.64.2
  • @tanstack/react-query-devtools ^5.64.2
  • @types/mdx ^2.0.13
  • framer-motion ^11.17.0
  • lodash ^4.17.21
  • next ^14.2.23
  • react ^18
  • react-dom ^18
  • zustand ^5.0.3