Skip to content

emblumenthal/datasets-explorer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Datasets Explorer

search and explore datasets by subject area and dataset name The app loads a JSON database of datasets and allows filtering by typing in the search box. Each dataset includes:

  • subject_area – the field or category of the dataset
  • dataset – the dataset name (clickable link)
  • dataset_link – URL to the dataset
  • description – short description of the dataset

The app is hosted on GitHub Pages: Datasets Explorer


Features

  • Search by subject area or dataset name
  • Dynamic, live filtering as you type
  • Clickable dataset links that open in a new tab
  • Lightweight and fast, built with React + Vite
  • JSON data stored in public/datasets.json for easy updates

Getting Started

1. Clone the repository

git clone https://github.com/emblumenthal/datasets-explorer.git
cd datasets-explorer

2. Install dependencies

npm install

3. Run the development server

npm run dev

4. Build for production

npm run build
  • This generates the dist/ folder for deployment.

5. Preview the production build locally

npm run preview

Deployment

This project is deployed on GitHub Pages. To deploy:

  1. Install gh-pages if not already:
npm install --save-dev gh-pages
  1. Add deploy scripts in package.json:
"scripts": {
  "predeploy": "npm run build",
  "deploy": "gh-pages -d dist"
}
  1. Deploy:
npm run deploy

JSON Dataset Format

The app expects a JSON file (public/datasets.json) with the following structure:

[
  {
    "subject_area": "Health",
    "dataset": "CDC Mortality Data",
    "dataset_link": "https://www.cdc.gov/data",
    "description": "Mortality statistics for US populations."
  },
  {
    "subject_area": "Education",
    "dataset": "NCES School Data",
    "dataset_link": "https://nces.ed.gov/",
    "description": "Data on schools, enrollments, and performance."
  }
]

Contributing

  • Add new datasets by editing datasets.json in the public/ folder
  • Open a PR with improvements or bug fixes
  • Make sure to test locally (npm run dev) before submitting changes

Tech Stack

  • React – UI library
  • Vite – Build tool
  • GitHub Pages – Hosting

License

This project is open-source under the MIT License.

About

An interactive tool to find research datasets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published