Skip to content

jaynewey/slinky

Repository files navigation

Slinky

CI GitHub Prettier Yarn

TypeScript React TailwindCSS Charm Icons Vite

In browser graphical Graph editor

Try it out!


Slinky allows you to graphically build and edit (currently unweighted, directed) graphs via a GUI in the browser, and import/export into CSV format (more formats are planned!).

Roadmap

  • More serialisation formats
    • CSV
    • JSON
    • XML
    • Something else? Open an issue!
  • Arbitrary node metadata
  • Keyboard shortcuts
  • Editor settings
  • Edge labels
  • Less bugs :¬)

Contributing

Contributions are welcome. Please open an issue discussing the change before sending a PR.

Development

Run the Vite dev server with:

$ yarn dev

Building

The project is written in TypeScript. Build the project with:

$ yarn build

Formatting

The project is formatted with Prettier. Format all files using:

$ yarn format

Check formatting with:

$ yarn format:check

Technologies and libraries