# mindmapp

**Repository Path**: nickling/mindmapp

## Basic Information

- **Project Name**: mindmapp
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-15
- **Last Updated**: 2021-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
    <h1 align="center">
         :broken_heart: Project no longer supported
    </h1>
    <p align="center">Fork it to continue development!</p>
</p>

<a href="https://mindmapp.cedoor.dev" target="_blank">
    <img src="https://raw.githubusercontent.com/Mindmapp/mindmapp/master/src/assets/images/readme-header.png">
</a>

<p align="center">
    <h1 align="center">
        <img width="40" src="https://raw.githubusercontent.com/Mindmapp/mindmapp/master/src/assets/icons/icon-72x72.png">
        Mindmapp <sup>beta</sup>
    </h1>
    <p align="center">Web application to draw mind maps.</p>
</p>
    
<p align="center">
    <a href="https://github.com/Mindmapp" target="_blank">
        <img src="https://img.shields.io/badge/project-Mindmapp-blue.svg?style=flat-square">
    </a>
    <a href="https://opencollective.com/mindmapp" alt="Financial Contributors on Open Collective">
        <img src="https://opencollective.com/mindmapp/all/badge.svg?label=financial+contributors">
    </a>
    <a href="https://gitter.im/mindmapp/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge" target="_blank">
        <img src="https://badges.gitter.im/mindmapp/community.svg">
    </a>
    <a href="https://github.com/Mindmapp/mindmapp/blob/master/LICENSE" target="_blank">
        <img src="https://img.shields.io/github/license/mindmapp/mindmapp.svg?style=flat-square">
    </a>
    <a href="https://david-dm.org/mindmapp/mindmapp" target="_blank">
        <img src="https://img.shields.io/david/mindmapp/mindmapp.svg?style=flat-square">
    </a>
    <a href="https://david-dm.org/mindmapp/mindmapp?type=dev" target="_blank">
        <img src="https://img.shields.io/david/dev/mindmapp/mindmapp.svg?style=flat-square">
    </a>
</p>

___

## :paperclip: Table of Contents
- :rocket: [Features](#rocket-features)
- :hammer: [Install](#hammer-install)
- :video_game: [Usage](#video_game-usage)
- :chart_with_upwards_trend: [Development](#chart_with_upwards_trend-development)
  - :scroll: [Rules](#scroll-rules)
    - [Commits](#commits)
    - [Branches](#branches)
- :raised_hand: [Contributors](#raised_hand-contributors)
  - :computer: [Code Contributors](#computer-code-contributors)
  - :moneybag: [Financial Contributors](#moneybag-financial-contributors)
- :page_facing_up: [License](#page_facing_up-license)
- :telephone_receiver: [Contacts](#telephone_receiver-contacts)
  - :boy: [Developers](#boy-developers)

## :rocket: Features

| Feature | Status | Description |
|---------|:------:|-------------|
| Basic mind map properties | :heavy_check_mark: | Set node images, colors and font properties. |
| Undo/Redo | :heavy_check_mark: | History of map changes. |
| Map centering | :heavy_check_mark: | Center map in x, y, z axes. |
| Shortcuts | :heavy_check_mark: | Main shortcuts to speed things up. |
| Local storage | :heavy_check_mark: | Save maps in the browser local storage. |
| JSON import/export | :heavy_check_mark: | Export and import maps as JSON file. |
| Image & PDF export | :heavy_check_mark: | Export maps as image (png, jpg) or PDF document. |
| PWA support | :heavy_check_mark: | Support of desktop and mobile browser PWA (Progressive Web App). |
| p2p database | :x: | Orbit (or something else) peer-to-peer database to share and eventually sync maps. |
| Plugin system | :x: | A plugin system to add third-party features. |
| Multiple selection | :x: | Select multiple nodes at the same time. |
| Multiple maps | :heavy_check_mark: | Multiple maps at the same time with multi-tabs. |

## :hammer: Install

With the following installed:
- git
- node >= 12
- npm >= 6

Clone the repo and install the dependencies from npm.

```bash
git clone https://github.com/Mindmapp/mindmapp.git
cd mindmapp
npm i
```

## :video_game: Usage

For local *development* with angular dev server:

```bash
npm start
```

Then open [http://localhost:4200](http://localhost:4200) in your browser.

If you want to generate the project documentation:

```bash
npm run doc
```

A `documentation` folder will be generated in the project path.

## :chart_with_upwards_trend: Development

### :scroll: Rules

#### Commits

* Use this commit message format (angular style):  

    `[<type>] <subject>`
    `<BLANK LINE>`
    `<body>`

    where `type` must be one of the following:

    - feat: A new feature
    - fix: A bug fix
    - docs: Documentation only changes
    - style: Changes that do not affect the meaning of the code
    - refactor: A code change that neither fixes a bug nor adds a feature
    - test: Adding missing or correcting existing tests
    - chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
    - update: Update of the library version or of the dependencies

and `body` must be should include the motivation for the change and contrast this with previous behavior (do not add body if the commit is trivial). 

* Use the imperative, present tense: "change" not "changed" nor "changes".
* Don't capitalize first letter.
* No dot (.) at the end.

#### Branches

* There is a master branch, used only for release.
* There is a dev branch, used to merge all sub dev branch.
* Avoid long descriptive names for long-lived branches.
* No CamelCase.
* Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit).
* Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
* Use slashes to separate parts of your branch names.
* Remove branch after merge if it is not important.

Examples:
    
    git branch -b docs/README
    git branch -b test/one-function
    git branch -b feat/side-bar
    git branch -b style/header

## :raised_hand: Contributors

Mindmapp is a work in progress. Remember that if you want you can make a small contribution with a pull request.

### :computer: Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/Mindmapp/mindmapp/graphs/contributors"><img src="https://opencollective.com/mindmapp/contributors.svg?width=890&button=false" /></a>

### :moneybag: Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/mindmapp/contribute)]

#### Individuals

<a href="https://opencollective.com/mindmapp"><img src="https://opencollective.com/mindmapp/individuals.svg?width=890"></a>

#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/mindmapp/contribute)]

<a href="https://opencollective.com/mindmapp/organization/0/website"><img src="https://opencollective.com/mindmapp/organization/0/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/1/website"><img src="https://opencollective.com/mindmapp/organization/1/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/2/website"><img src="https://opencollective.com/mindmapp/organization/2/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/3/website"><img src="https://opencollective.com/mindmapp/organization/3/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/4/website"><img src="https://opencollective.com/mindmapp/organization/4/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/5/website"><img src="https://opencollective.com/mindmapp/organization/5/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/6/website"><img src="https://opencollective.com/mindmapp/organization/6/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/7/website"><img src="https://opencollective.com/mindmapp/organization/7/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/8/website"><img src="https://opencollective.com/mindmapp/organization/8/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/9/website"><img src="https://opencollective.com/mindmapp/organization/9/avatar.svg"></a>

## :page_facing_up: License
* See [LICENSE](https://github.com/cedoor/ceditor/blob/master/LICENSE) file.

## :telephone_receiver: Contacts
### :boy: Developers
* e-mail : me@cedoor.dev
* github : [@cedoor](https://github.com/cedoor)
* website : https://cedoor.dev