# 🚨 No longer maintained

Thank you for your interest in this project. Unfortunately, I am no longer maintaining it. I highly recommend checking out [TeamMapper](https://github.com/b310-digital/teammapper), which is actively developed and maintained by other developers, or fork it yourself!

#     Mindmapp beta

Web application to draw mind maps.

## :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
1git clone https://github.com/Mindmapp/mindmapp.git
2cd mindmapp
3npm i
```

## :video_game: Usage

For local _development_ with angular dev server:

```bash
1npm start
```
Then open [http://localhost:4200](http://localhost:4200/) in your browser.

If you want to generate the project documentation:

```bash
1npm 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):

```
[]
```

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 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:

```bash
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](/content/cedoor/CONTRIBUTING.md).

### :moneybag: Financial Contributors

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

#### Individuals

#### 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)

## :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