diff --git a/README.md b/README.md index b919fc2a..4b26d890 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ WiseMapping is an open-source web-based mind mapping tool that harnesses the potential of Mind Maps by blending together open standards technologies like SVG and React. It is built upon the foundation of the code supporting http://www.wisemapping.com, ensuring reliability and continuity in its development. -# Compile and Development +# Build and Start Application The following section describes the steps to check out, compile, and start WiseMapping locally. If you are interested in deploying it, I recommend using the already published images https://hub.docker.com/r/wisemapping/wisemapping. @@ -19,13 +19,12 @@ The following command line will start WiseMapping locally using HSQLDB in memory ``` $ mvn -f wise-api/pom.xml package -$ docker compose build -$ docker compose up +$ docker compose up --build ``` Application will start at http://localhost/c/login. You can login using *test@wisemapping.org* and password *test* -## Option 2: Start FrontEnd and Backend API +## Option 2: Start Frontend and Backend API ### Compile and Start API @@ -53,13 +52,12 @@ Application will start at http://localhost:3000/c/login. You can login using *te # Supportability Matrix -## Supported Databases +## Databases * MySQL v8 or higher * PostgreSQL v15 or higher * Hsqldb v2.7 or higher - # Configuration WiseMapping backend is based on SpringBoot v3 and it's highly customizable. Additional documentation can be found [here](https://docs.spring.io/spring-boot/3.3/reference/features/external-config.html)