sankeydiagram.net
sankeydiagram.net copied to clipboard
sankeydiagram.net is an easy-to-use webapp for generating Sankey Diagrams to visualize flows and budgets.
SankeyDiagram.net
About
SankeyDiagram.net is a simple and modern generator for Sankey Diagrams.
Live Version: https://sankeydiagram.net/
Example Diagram: https://sankeydiagram.net/?content=PTAEGUHkFUCUGECioD...
Develop
- run dev-server:
npm run start
- build:
npm run build
- lint:
npm run lint
- fix codestyle:
npm run lint:fix
- update dependency(if needed):
npm i [dependencyName]@[version]
(use can use@latest
for the latest version)
Live version of the dev branch: https://dev.sankeydiagram-net.pages.dev/
There is also a Dockerfile available for local testing. Please mind that the Dockerfile is not (yet) production ready, since it runs a local parcel server.
Use docker build -t sankeydiagramnet . && docker run -p 1234:1234 sankeydiagramnet
to start your a docker container at port 1234.
Contact
If you have any questions, need help, a special license, or something else, you can contact me via GitHub Issues, or using the following methods:
- mail: [email protected]
- web: jonasdoesthings.com
Credits
Major Libraries Used
- The Sankey Diagram D3 extension is based on https://github.com/ricklupton/d3-sankey-diagram
- D3 - https://github.com/d3/d3
- For exporting images - https://github.com/exupero/saveSvgAsPng
- For copying to the user's clipboard - https://github.com/zenorocha/clipboard.js
- For compressing the sharing URL - https://github.com/pieroxy/lz-string
License
(See LICENSE.md)
This piece of software is licensed under the MIT with a Common Clause. That basically means, that you are allowed to view, edit, fork, this project, but not sell it. (No legal advice)
If you want to use this project and need special licensing, contact me.