Skip to content

digitalgeosciences/futuregeo

Repository files navigation

FutureGeo - Geoscience & the SDGs

DOI License Release

An interactive single-page experience showing how geoscientists advance the UN Sustainable Development Goals, with insights, impact stories, and discipline highlights.

Prerequisites

  • Node.js 18+ (LTS recommended)
  • npm 9+ (or your preferred Node package manager)

Getting started

git clone https://github.com/digitalgeosciences/futuregeo.git
cd FutureGeo
npm install
npm run dev

Open the printed local URL (typically http://localhost:5173) in your browser.

Available scripts

  • npm run dev - Start the Vite development server with hot reloading.
  • npm run build - Create a production build in the dist folder.
  • npm run build:dev - Development-mode build (useful for debugging production config).
  • npm run preview - Preview the production build locally.
  • npm run lint - Run ESLint on the project.

Project structure

  • src/pages - Page-level routes (home, insights archive, insight detail, 404).
  • src/components - Page sections and shared components (Hero, GeoscienceImpact, Disciplines, SDGSection, Footer).
  • src/components/ui - Minimal shadcn/ui primitives in use (accordion, button, card, toast/sonner).
  • src/content - Markdown posts for insights.
  • public/data - Static data (geoscience specializations CSV).

Tech stack

  • Vite + React 18 + TypeScript
  • Tailwind CSS + shadcn/ui
  • React Router

Data entry

  • public/data/geoscience-specializations.csv - Specializations and related metadata.
  • src/content/sdg-posts - Markdown insight posts; follow the existing front matter fields.

Deployment

The app is a static site that can be deployed to any static hosting provider (GitHub Pages, Netlify, Vercel, etc.).

For GitHub Pages with GitHub Actions (see .github/workflows/deploy.yml):

  1. Push this repository to GitHub.
  2. In repo settings, enable GitHub Pages with the GitHub Actions source.
  3. Ensure the default branch name in deploy.yml matches your repo (e.g. main).
  4. Push to the default branch - the workflow will build and deploy automatically.

Manual deploy:

npm run build

Upload the dist contents to your static hosting provider.

Citation

Alqubalee, A. (2025). FutureGeo (v0.1.0). Zenodo. https://doi.org/10.5281/zenodo.17915560