Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.82 KB

README.md

File metadata and controls

46 lines (34 loc) · 2.82 KB

SankeyDiagram.net

sankeydiagram.net screenshot

About

SankeyDiagram.net is a simple and modern generator for Sankey Diagrams.

Live Version: https://sankeydiagram.net/
Example Diagram: https://sankeydiagram.net/?content=PTAEGUHkFUCUGECioD...
User Guide: https://sankeydiagram.net/how-to/create-a-sankey-diagram

Buy Me A Coffee

Develop

⚠️ Check out the dev branch! Development happens on the dev branch! ⚠️

  • 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 running. It builds the app and runs a nginx server to serve the static files.
Use docker build -t sankeydiagramnet . && docker run -p 80:80 sankeydiagramnet to start you a docker container at local port 80.

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:

Credits

Major Libraries Used

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.