Developer Notes

This project is built with SvelteKit.

Project overview

src/components - This package includes the Svelte components for the project.
src/data - This package includes routines to work with source data.
src/lib - This package contains implementation details used by the frontend.
src/routes - This package includes the http routes for the application. These routes are managed by and organized according to the conventions of the SvelteKit router.
src/styles - This package includes the Sass styles used in the project, with USWDS theming. See postcss.config.cjs for details on how these are compiled.

Install dependencies:

npm install

Next, start a development server:

npm run dev

# ... or start the server and open the app in a new browser tab
npm run dev -- --open

To produce a production build:

npm run build

You can also preview the production build locally:

npm run preview

Jupyter notebooks are available in the ./notebooks directory. To use, you must install the Python dependencies and the tslab Jupyter kernel.

Install Python dependencies using Poetry:

poetry install

To register the tslab kernel with Jupyter:

npx tslab install --python=`poetry run which python`

# To confirm that tslab is available, run:
poetry run jupyter kernelspec list

Finally, to run a local Jupyter server:

poetry run jupyter notebook