Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 1.87 KB

README.md

File metadata and controls

68 lines (44 loc) · 1.87 KB

mdwiki

Simple wiki based on locally stored markdown files.

Features

  • retrieve markdown files in json with GET
  • create new markdown document with POST

Planned Features

  • add embedded Jetty server to make standalone app
  • view markdown documents rendered as html
  • version control md documents with git
  • integrate solr Lucene to provide search capabilities
  • integrate Spring Security

Usage

  • GET mdwiki/markdown/<document>.json where document is without extension.

  • POST mdwiki/markdown with body

      {
    "author" : <author>,
    "name" : <filename>,
    "content" : <file-content>
  }

    curl

      curl -X POST -H "Content-Type: application/json" -d '{"name":"post-test","author":"post-author","content":"post-content"}' http://localhost:8080/mdwiki/markdown

Project Defaults

  • WIKI_ROOT=~/wiki/markdown directory the app looks for markdown files. Flat, subirecties are not scanned
  • DEFAULT_ENCODING=UTF-8 encoding of markdown documents
  • LINE_SEPARATOR=\n
  • MARKDOWN_EXTENSION=md
  • DEFAULT_AUTHOR=default-author

override with -D<parameter>=<value> at startup

Notes

Running app from command line

mvn tomcat:run

This will install every dependencies both for the backend and frontend.

Afterwards you can reach the app in the browser on localhost:8080/kicsikrumpli

Developing the frontend

The following commands should be given out in the webappsrc folder

npm install
gulp watch

Upon changing/adding any javascript, html file in the app folder it will bundle them together into the build.js file.

Reading materials