Skip to content

Starterkit for data visualization applications based on Svelte and SvelteKit.

Notifications You must be signed in to change notification settings

wiederkehr/datavis-starterkit

Repository files navigation

Data Visualization Starterkit

Features

Frameworks

  • ✅ Svelte as component framework
  • ✅ SvelteKit as application framework

Compilers and Transpilters

  • ✅ svelte-preprocess for transforming JS and CSS supersets
  • ✅ Sass as CSS superset
  • ✅ TypeScript as JS superset
  • ✅ PostCSS for transforming CSS styles
  • ✅ PostCSS with autoprefixer to add vendor prefixes to CSS rules

Libraries

Structure

  • ✅ Basic Folder structure
    • ✅ Folder src/actions for use actions for components
    • ✅ Folder src/components for components
    • ✅ Folder src/data for storing static data files
    • ✅ Folder src/routes for pages
    • ✅ Folder src/stores for stores of data
    • ✅ Folder src/functions for utility functions
  • ✅ Basic CSS file structure
    • ✅ File src/styles/app for importing all following files
    • ✅ File src/styles/base for root CSS styling
    • ✅ File src/styles/constants for CSS and JS constants
    • ✅ File src/styles/fonts for @font-face declarations
    • ✅ File src/styles/reset for CSS style reset across browsers
    • ✅ File src/styles/variables for CSS variables
  • 🅾️ Basic README structure

Code

  • ✅ Prettier configuration for CSS, JS, Svelte

Infrastructure

  • 🅾️ Deployment on Github Pages
  • 🅾️ Deployment on Vercel

Misc

  • ✅ Vite configuration for loading CSV and TSV files

Components and Recipes

  • ✅ Data loading
  • ✅ Data exporting
  • ✅ Chart component
  • ✅ Custom fonts from Google Fonts
  • ✅ Sticky chart layout
  • ✅ Theme toggle with localStorage
  • ✅ SVG exporting
  • ✅ Interface component
  • 🅾️ Search with autocomplete

Stores

  • ✅ Store for width and height of the viewport
  • ✅ Store for media queries
  • ✅ Store for theme
  • ✅ Store state as URL parameter
  • 🔄 Store for user interface state

Actions

  • ✅ Action for checking if a component is in the viewport
  • ✅ Action for checking if the user clicked outside a component

Development

Start a development server:

yarn dev

Or start the server and open the app in a new browser tab:

yarn dev --open

Building

To create a production build:

yarn build

To preview the production build:

yarn preview

Deployment

Install an adapter for the target environment.

About

Starterkit for data visualization applications based on Svelte and SvelteKit.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published