Skip to content

rskew/knowwhat

Repository files navigation

Knowwhat

Graph drawing for mindmapping, knowledge engineering and creative-tool-making.

example graph

Quick start

You will need Docker and docker-compose installed.

From the repo root, run docker-compose -f deployment/docker-compose.yml up, then head to localhost:8085 in the browser. You should see a blank graph with title 'home', ready for editing :D

Double-click on the background to add a new node, and explore from there.

The interface is under development. The best way to find out what commands are supported is to look at the handleKeypress function in src/GraphComponent/handleAction.purs.

Development

For development, bring up the backend with docker-compose. Run a local devserver for your modified frontend with parcel.

We use spago to manage our Purescript dependencies. While this is installed as a dev-dependency in package.json you may want to install it directly to make it easier to manage these dependencies directly.

After running spago test to compile the purescript to javascript, run parcel assets/index.html to build the front-end and run a dev server you can point your browser at.

Parcel's hot-loading doesn't gel with the Halogen app, so you'll have to manually reload the browser tab after changing the code.

License

The project is licensed under the terms of the Apache License (Version 2.0).

See LICENSE or http://www.apache.org/licenses/LICENSE-2.0 for details.