Skip to content

README.md

Latest commit

 

History

History
53 lines (34 loc) · 1.44 KB

README.md

File metadata and controls

53 lines (34 loc) · 1.44 KB

PG Atlas Frontend

Frontend dashboard for PG Atlas — the metrics backbone for the SCF Public Goods dependency graph. Built with Vite, React, TanStack Router, and TanStack Query.

Built as free open-source software under the Mozilla Public License 2.0.

pre-commit.ci status

Local Development

Prerequisites

  • Node.js 18+ (recommend 20 LTS)
  • npm (or pnpm / yarn)

Setup

git clone https://github.com/SCF-Public-Goods-Maintenance/pg-atlas-frontend.git
cd pg-atlas-frontend
npm install

Install pre-commit hooks (optional)

If the repo uses pre-commit:

# From repo root (pg-atlas-frontend)
pre-commit install --install-hooks --hook-type pre-commit --hook-type commit-msg

Run the app

npm run dev

The app will be available at http://localhost:5173 (or the port Vite prints).

Lint and type-check

npm run lint
npm run build

build runs the TypeScript compiler and Vite build; a successful build implies type-checking passes.

License

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
A copy of the MPL is in the LICENSE file in this repository.