Merged in bugfix/update-readme-file (pull request #72)

docs(readme): update readme file

* docs(readme): update readme file


Approved-by: Paulo Veiga
This commit is contained in:
Clément CREUSAT 2023-06-30 13:13:29 +00:00 committed by Paulo Veiga
parent 6c41beb45e
commit 3775202d7f

View File

@ -1,12 +1,12 @@
# WiseMapping Frond End
WiseMapping Frond End is part of the [MindMap Open Source Project](http://www.wisemapping.org). The first release of WiseMapping was in 2010 and there was not mayor update on the architecture. In 2021, a major change started with the goal to provide a visual and technology refresh of the project.
WiseMapping Frond End is part of the [MindMap Open Source Project](http://www.wisemapping.org). The first release of WiseMapping was in 2010 and there was not mayor update on the architecture. In 2021, a major change started with the goal to provide a visual and technology refresh of the project.
WiseMapping Front extracts all the UI related aspects in this repository. You will find three major modules:
* Web2D: Lighway abstraction over SVG for chart renderding.
* Mindplot: Pure vanilla ES6 classes responsible for providing mindmap rendering and edition capabilities.
* Webapp: REACT application that encompass the whole midnmap edition experience.
- Web2D: Lighway abstraction over SVG for chart renderding.
- Mindplot: Pure vanilla ES6 classes responsible for providing mindmap rendering and edition capabilities.
- Webapp: REACT application that encompass the whole midnmap edition experience.
## Getting started
@ -15,7 +15,6 @@ Make sure you have NodeJs installed (version compatible with `package.json` engi
```
nvm use
yarn install
yarn bootstrap
```
Please refer to each package's Readme.md for anything specific to the package.
@ -72,4 +71,4 @@ A workaround for this is to run the tests using docker. Make sure you have docke
Run snapshot tests: `docker-compose -f docker-compose.snapshots.yml up`
If anything changed, and the change was intentional, update the snapshots and then commit the new images to source control.
Update snapshots: `docker-compose -f docker-compose.snapshots.update.yml up`
Update snapshots: `docker-compose -f docker-compose.snapshots.update.yml up`