Skip to content

marcoklein/mindnotes

Repository files navigation

Build Status Known Vulnerabilities

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.