Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marcoklein/mindnotes

Text driven mind map creation.
https://github.com/marcoklein/mindnotes

d3js mind-map text-driven web

Last synced: 4 days ago
JSON representation

Text driven mind map creation.

Awesome Lists containing this project

README

        

[![Build Status](https://travis-ci.org/marcoklein/mindnotes.svg?branch=master)](https://travis-ci.org/marcoklein/mindnotes)
[![Known Vulnerabilities](https://snyk.io//test/github/marcoklein/mindnotes/badge.svg?targetFile=package.json)](https://snyk.io//test/github/marcoklein/mindnotes?targetFile=package.json)

# mind-map-notes
Text driven mind map creation.

# Getting Started

## Development

Install dependencies
```
npm install
```

Run the application
```
npm run serve
```

## Project Structure

```
src/
core/ <-- Shared code among editor and renderer
events/ <-- Editor and renderer communicate via events
parser/ <-- Parse text into events
editor/ <-- Text editor to modify the mindmap
renderer/ <-- Rendering the mindmap
```

# Development

## GitHub Pages

GitHub Pages is used to deploy the website. The used plugin `gh-pages` builds a fresh copy to the `gh-pages` branch by running the command `npm run deploy`.

This setup will always deploy the website for the currently active branch.