Skip to content

Repository files navigation

PublicRecord

Healthcare transparency platform bringing accountability through public data. Built with open data from CMS, HCRIS cost reports, and other public sources.

Tech Stack

  • Framework: Next.js (App Router) + TypeScript
  • Styling: Tailwind CSS
  • Database: Supabase (PostgreSQL + PostGIS)
  • Auth: Supabase Auth
  • Storage: Supabase Storage
  • Hosting: Vercel
  • Maps: Mapbox GL JS
  • Data Pipeline: GitHub Actions (scheduled workflows)

Getting Started

Prerequisites

  • Node.js 18+
  • npm
  • A Supabase project with PostGIS enabled

Setup

  1. Clone the repository:

    git clone https://github.com/sgarvin-lux/publicrecord.git
    cd publicrecord
  2. Install dependencies:

    npm install
  3. Copy the environment variables template and fill in your values:

    cp .env.local.example .env.local
  4. Start the development server:

    npm run dev

    Open http://localhost:3000 in your browser.

Scripts

Command Description
npm run dev Start development server
npm run build Build for production
npm run start Start production server
npm run lint Run ESLint
npm run format Format code with Prettier
npm run format:check Check formatting
npm run type-check Run TypeScript type checking

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Commit your changes
  4. Push to the branch and open a Pull Request

Ensure your code passes npm run lint and npm run type-check before submitting.

License

MIT — see LICENSE for details.

About

initial repository for Public Record MVP

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages