PayTransparency.work

PayTransparency.work is built by David Reed using SvelteKit, Heroicons, and Tailwind CSS.

United States map icons are from coryetzkorn and originally derive from ProPublica's StateFace. Canada map icons are derived from Wikimedia's Canada map.

This site is open source and available under the MIT License. Want to improve the site, or add more transparency data? Open a Pull Request on GitHub!

Working on the Application

To work on PayTransparency.work, follow these steps.

Using NPM

1. Ensure that you have git and npm (NodeJS 20) installed on your computer.
2. Clone the Git repo.
3. Run npm install in the repo to install dependencies.
4. Run npx husky install to add pre-commit Git hooks.
5. Run npm run dev to start the hot-reloading dev environment.
6. Run npm run build to build the static files. This is important to validate that changes don't impact SvelteKit's ability to statically render the entire site.

Using Nix and Direnv

The PayTransparency.work repo is a Nix flake. If you want to use Nix to develop, it will automatically install the right Node version and manage all of the NPM dependencies for you.

1. Ensure that you have Nix set up on your computer.
2. If desired, set up direnv and optionally nix-direnv.
3. Clone the Git repo.
4. Run npx husky install to add pre-commit Git hooks.

If you're using direnv:

1. cd into the repo.
2. Run direnv allow to permit the use of this repo's environment.
3. Run npm run dev to start the hot-reloading dev environment.
4. Run npm run build to build the static files. This is important to validate that changes don't impact SvelteKit's ability to statically render the entire site.

If you're not using direnv:

1. cd into the repo.
2. Run nix develop to start a dev shell. Note that the dev shell is isolated from any configuration of your usual shell.
3. Run npm run dev to start the hot-reloading dev environment.
4. Run npm run build to build the static files. This is important to validate that changes don't impact SvelteKit's ability to statically render the entire site.