limedelete1 v0.0.3

Simplify Diagramming with Svelvet!

Svelvet is a lightweight Svelte component library for building interactive node-based diagrams.

⚡ Getting Started | 📚 Documentation | ⌨️ Blog | 💬 Twitter | 💼 LinkedIn

Version Updates

Shout out to our contributors! Here's what's new:

Changelog

Key Features

• Easy to use: To get started with Svelvet, all you need is data for nodes and edges. Visit our documentation website for streamlined, user-friendly tutorials and examples on how to get the most out of your Svelvet flowchart!
• Interactive: Elegant and smooth interface when selecting a node to drag it across the graph.
• Customizable: Ability to customize your nodes and edges (node size, color, border and edge type, label, anchor). More coming soon!
• Fast rendering: Re-rendering is based on changes to initial values for nodes, edges and optional background and movement (collaborator credit to dvisockas).
• Reliable: Svelvet is written in TypeScript and tested with Vitest, Cypress and Svelte Testing Library. Svelvet is maintained by motivated engineers seeking to contribute to the larger Svelte developer community and library ecosystem.
• Room to Grow: There is so much we can do to improve, add features and make Svelvet the best version of itself - we welcome feedback and contributions! Scroll below for suggestions on what to contribute.

Installation

Svelvet is available as both an npm and a yarn package. You can install it by running one of the two commands:

npm install svelvet

yarn add svelvet

Quick Start

Start by importing Svelvet into your application:

import Svelvet from 'svelvet';

A Svelvet component consists of nodes and edges (or just nodes). You can pass nodes and edges as props to the Svelvet component. By default, Svelvet components allow for the ability to move nodes and edges as well as pan and zoom. However, if you would like to render a fixed diagram, simply pass in the movement attribute and set it's value to false! You can add a dot-grid background like the example below. With the information that you provide for your nodes and edges, Svelvet will do all of the work behind-the-scenes to render your flowchart!

<Svelvet nodes={nodes} edges={edges} movement background />

Visit our website to learn more on how to customize your nodes and edges to your liking!

Testing

Testing is done with Vitest and the Svelte Testing Library. You can find tests in the /tests folder. In order to run the tests use the command:

For Unit testing

npm run test:unit

For End-to-End testing

npm run cypress:open

The Svelvet Team

• Aaron Willett • LinkedIn • Github
• Alexander Zambrano • LinkedIn • Github
• Andrew Widjaja • LinkedIn • Github
• Anu Sharma • LinkedIn • Github
• Justin Wouters • LinkedIn • Github
• Walter DeVault • LinkedIn • Github
• Ali Adams • LinkedIn • Github
• Von Garcia • LinkedIn • Github
• Damian Lim • LinkedIn • Github
• Christopher Mander • LinkedIn • Github
• David Jakubiec • LinkedIn • Github
• Jeffrey Wentworth • LinkedIn • Github
• Johnny Tran • LinkedIn • Github
• Samee Vohra • LinkedIn • Github
• Abhi Gullapalli • LinkedIn • Github
• Ian Hnizdo • LinkedIn • Github
• Mauricio Castro • LinkedIn • Github
• Ryan Potter • LinkedIn • Github
• Emma Ferguson • LinkedIn • Github
• Dillon McKenna • LinkedIn • Github
• Taylor Alan • LinkedIn • Github
• Timmy Lem • LinkedIn • Github
• Tony Lim • LinkedIn • Github
• Ernesto Gonzalez • LinkedIn • Github
• Michael Chiang • LinkedIn • Github
• Rachel He • LinkedIn • Github
• Horacio Vallejo • LinkedIn • Github

Forking the Repository

If you'd like to fork the repository and run it locally, you'll need to perform a couple of steps to in order to get everything working properly:

• Create an account on Supabase
• Create a new project in Supabase (you can name this whatever you want)
• Rename the 'supabase_env' file to '.env' and paste in the API keys from your newly created supabase project into the .env file

Once that is done you should be able to render the website locally on localhost:3000, although you will be missing some minor functionality tied to the production database (e.g. OAuth login).

How to Contribute

Read src/lib/doc/README.md for suggestions on how to get started!

The following is a list of features and improvements by ourselves and the larger Svelte community for any open source developer to contribute. If you have any additional ideas, feel free to raise the issue or implement them as well!

• Premade node menu with drag & drop abilities
• Rotating of nodes
• Add documentation/video tutorial on how to set up a Svelvet demo
• Custom error handling
• Increase test coverage for scalability
• More styling and customization of edges for complex Svelvet flow diagrams
• Community Forum
• GET CREATIVE!! Svelvet is an amazing project that has so much room to grow.

Credits

Inspired by React Flow, Svelvet expands the tools available to Svelte developers and makes Svelte more inviting to both new and seasoned software engineers. Under the hood, Svelvet depends on the d3-zoom library to zoom and pan across the graph.

License

Svelvet is developed under the MIT license.