Dataverse Metadata Field Lookup

Dataverse Metadata Field Lookup is a static Astro application for searching and browsing metadata blocks and fields in a Dataverse installation, with specifications and context.

The audience of this tool is primarily:

1. Researchers - to understand the available fields when depositing data, and to learn best practices for using them.
2. Curators - to understand the available fields when curating/reviewing datasets.

Features

• Search the definitions of metadata fields and blocks in a Dataverse installation.
• Full-text search across each field's added context, including best practices and examples.
• Browse available metadata fields by block.
• Filter fields by metadata block, required-only, and best practice tier (Recommended/Optional).
• Share or bookmark a filtered view: the search and filters are kept in the page URL. See URL parameters.
• Multi-language support. See Internationalization.

Prerequisites

• Node.js 22.19.0 or newer
• pnpm
• Dataverse installation 6.3 or later

Development

Install dependencies:

pnpm install

Start Astro's background development server and manage it with:

pnpm astro dev --background
pnpm astro dev status
pnpm astro dev logs
pnpm astro dev stop

Run automated verification and create a production build:

pnpm test
pnpm check
pnpm build

Release

This repository uses release-it to automate versioning and changelog generation. To create a new release, run:

pnpm release

Data

Metadata schema

Astro validates src/data/metadata.json at render time. See docs/schema.md for that schema, or src/lib/metadata.ts for the TypeScript types.

To check the data before a build or deployment:

pnpm test src/lib/metadata.test.ts

Updating the metadata

To fetch the latest metadata blocks and fields from the installation set in src/site.config.ts, run:

pnpm tsx scripts/update-metadata.ts

The script only rewrites src/data/metadata.json when the fetched metadata differs from it.

The Update metadata.json workflow runs this script daily at 02:00 UTC, or manually from the Actions tab. When the metadata has changed, it commits the new file to main, runs the tests and redeploys the site.

Internationalization

See docs/internationalization.md for instructions on adding a new locale and translating the interface, site text, and metadata descriptions.

Deployment

You can deploy the application to any static hosting service. For example, to deploy to GitHub Pages, follow the steps below:

2. Change the site value in astro.config.mjs to your GitHub Pages URL:

   export default defineConfig({
     site: 'https://<your-github-username>.github.io',
     // ...
   });
   

3. Point src/site.config.ts at your installation:

   export const site = {
     dataverseName: '{YOUR-DATAVERSE-NAME}',
     dataverseURL: '{YOUR-DATAVERSE-URL}',
     githubUrl: 'https://github.com/{YOUR-GITHUB-USERNAME}/dv-fields-lookup',
     // Optional: only include the metadata blocks enabled for one collection
     collectionId: '{YOUR-COLLECTION-ALIAS}',
   };
   

   Then change the site title, description and footer in src/i18n/locales/en.json — and in each other locale file you serve, since that text is translatable:

   {
     "site.title": "Dataverse Metadata Field Lookup",
     "site.description": "Search and explore metadata fields in {YOUR-DATAVERSE-NAME}, with specifications and best practices in context.",
     "site.footerText": "Made with ❤️ for the Dataverse community.",
     ...
   }
   

여기까지가 README 앞부분입니다. 나머지는 원문에서 읽을 수 있습니다. README 전문 보기 ↗