knowledgedb

README

KnowledgeDB

This is a little Knowledge Database for personal use written in Go There is no user authentication just some markdown processing and full-text-search.

Used 3rd Party Packages / Libs

• Blackfriday for markdown processing
• bluemonday for HTML sanitizing
• bleve for searching within the documents
• Bolt for document storage
• Bootstrap basic UI design
• gorilla/mux for http request routing
• highlight.js for syntax highlighting
• JQuery because some other libs needed it...
• Bootstrap Tags Input for tag input :-P
• typeahead.js also for tag input
• gouuid to generate unique IDs.
• service for running the webserver as a windows service.

Compile

To compile you could simply use go build or if you want some extra analyzers for the search engine build with go build -tags "icu libstemmer" For more information about additional search engine features see bleve...

Executing

Copy the compiled executable in the same directory as the static and the templates directory. If you want you can create a config.json

{
    "HttpAddr": ":12345",               // port / address for the http server
    "DataDir": "/var/knowledgedb/data", // directory to store the database and fulltext-search-index
    "DefaultAnalyzer": "standard"       // Textanalyzer for the bleve search.
}