techhat / mapjs

JavaScript Mind Map visualisation and management

Home Page:http://www.mindmup.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MindMup MapJs

Build Status

MindMup is a zero-friction mind map canvas. Our aim is to create the most productive mind mapping environment out there, removing all the distractions and providing powerful editing shortcuts.

This project is the JavaScript visualisation portion of MindMup. It provides a canvas for users to create and edit mind maps in a browser. You can see an example of this live at mindmup.com, or play with the library directly in the browser using test/index.html from this project..

This project is relatively stand alone and you can use it to create a nice mind map visualisation separate from the MindMup Server.

#Using MAPJS in your projects

Without dependencies

Use mindmup-mapjs.min.js from the dist folder. This includes no third-party scripts, so make sure you're including the dependencies separately as well.

With all the dependencies

Grab the module

npm install mindmup-mapjs

Export the library with all the dependencies into a single file for your browser

browserify -r mindmup-mapjs > mapjs.js

You can now include MAPJS into HTML files simply by using

var MAPJS = require('mindmup-mapjs')

#Testing

To run the unit tests, execute

npm test

To debug and try things out visually, grab the dependencies using:

npm run pretest

Then open test/index.html in a browser.

#Dependencies

This library depends on the following projects:

They are automatically downloaded using NPM and can be converted to a single file, lib/dependencies.js using the following command:

npm run pretest

If you don't yet have the (required) grunt executable on your path, you can get one as follows:

sudo npm install -g grunt-cli

About

JavaScript Mind Map visualisation and management

http://www.mindmup.com

License:MIT License


Languages

Language:JavaScript 98.6%Language:CSS 0.6%Language:HTML 0.6%Language:CoffeeScript 0.1%Language:Shell 0.0%