An open API service indexing awesome lists of open source software.

https://github.com/oslabs-beta/svolte

Open Source Svelte Developer Toolkit
https://github.com/oslabs-beta/svolte

debugger-extension debugging-tool dev developer-tool developer-tools devtool devtools devtools-extension svelte svelte-components svelte-devtool svelte-v3 svelte3 sveltejs time-travel time-travel-debugger time-traveling

Last synced: 4 months ago
JSON representation

Open Source Svelte Developer Toolkit

Awesome Lists containing this project

README

          


Svolte banner

# Overview

Svolte is an open source Chrome developer tool for time travel debugging and component hierarchy visualization in Svelte applications. Svolte enables developers to record snapshots of component states, visualize component props, inspect and jump between snapshots. Svolte is the first Svelte time travel debugger that is compatible with writable stores and includes a skip feature.

**Developed with**

[![Svelte](https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00)](#)
[![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](#)
[![D3.js](https://img.shields.io/badge/d3.js-F9A03C?style=for-the-badge&logo=d3.js&logoColor=white)](#)
[![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](#)
[![Vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E)](#)
[![Google Chrome](https://img.shields.io/badge/Google_chrome-4285F4?style=for-the-badge&logo=Google-chrome&logoColor=white)](#)

# Features

## Component Hierarchy and Props Visualization

Visualize the hierarchy of your Svelte app and check the props of each component.

tree demo gif

## Record and Inspect Component State Snapshots

Record the states of your components to see how each state has changed.

state inspection gif

## Jumping and Skipping

- Jump through each snapshot to recreate state changes.

- Have a snapshot you want to skip? Simply toggle skip to ignore that snapshot when you jump.

time travel gif

# Getting Started

## Download from the Chrome Store

Download the chrome extension [here](#).

This extension is only compatible with Svelte projects running in `development mode`, so be sure to check that configuration if you are not starting up your project with `npm run dev`.

## Manual Installation for Developers

Fork and clone this repository into your local machine. Once that is done, run the commands `npm i` and `npm run build` to download the dependencies and build the dev tool. Finally, making sure you toggle Developer mode `on` in your Chrome browser, you can load unpack the extension folder (located in the root level of the repository).

# How to Use

After installing the Chrome extension open up your project in Chrome, and be sure your Svelte application is running in `development mode`.

Right click your application and `Inspect` or press `f12` to open up Chrome Dev Tools, and navigate to the Svolte panel (which may be hidden behind `>>` if you have too many tabs).

You are then ready to debug your Svolte application!

open dev gif

# The Svolte Team






Harry Vu


LinkedIn Icon
GitHub Icon





Scott Kim


LinkedIn Icon
GitHub Icon





Ying-An Wang


LinkedIn Icon
GitHub Icon





Petros Ogbamichael


LinkedIn Icon
GitHub Icon

# Support

If you find Svolte to be useful please throw a :star2: our way and share this project with your Svelte developer friends!

# License

Svolte is developed under the [MIT license](/LICENSE).