https://github.com/marcoklein/mindnotes

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

d3js mind-map text-driven web

Last synced: about 1 month ago
JSON representation

Text driven mind map creation.

• Host: GitHub
• URL: https://github.com/marcoklein/mindnotes
• Owner: marcoklein
• License: mit
• Created: 2020-04-08T16:58:32.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-28T12:02:13.000Z (4 months ago)
• Last Synced: 2024-12-28T13:17:48.407Z (4 months ago)
• Topics: d3js, mind-map, text-driven, web
• Language: TypeScript
• Homepage: https://marcoklein.github.io/mindnotes/
• Size: 3.41 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - marcoklein/mindnotes - Text driven mind map creation. (web)

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.