Skip to content

volunL/Matterwiki4j

Repository files navigation

Matterwiki for Java

According to the react.js project Matterwiki, I rewrite it in Java based on Springboot.

Get Started

Just run this command to start the jar,and the server's port is 8080

java -jar  matterwiki-4j-boot-1.0-SNAPSHOT.jar

When the program finish starting ,visit this url

http://localhost:8080/

Run the project

Maven Command Description
mvn clean install performs a build
mvn clean package performs a build
mvn spring-boot:run (from matterwiki-4j-boot module) starts Matterwiki4j on a Tomcat instance at http://localhost:8080/

You can change the server's port with editing the property file named appliaction.properties in the jar.

Required environment

✨Java: at least version 1.8

This program will auto create a h2 database, you don't need to configure a database url.

API

API doc is showed on the page swagger-ui.html.
When the program finish starting,visit this url to read the api doc. http://localhost:8080/swagger-ui.html

Under the hood

Matterwiki4j uses React.js for the front-end and Springboot for the back-end.
Its default database is h2.

Screen Shot