top-ranger / writergo Goto Github PK

++++++++++++++++++++++++++++++++++++++++++++
WriterGo! - A simple editing software
   created by Marcus Soll (https://msoll.eu)
++++++++++++++++++++++++++++++++++++++++++++

WriterGo! is my personal collaboration edition software.
It was developed with simplicity in mind - both in deployment and architecture.
As such, it might contain certain restrictions in terms of extensibility.
I developed the software with my specific needs in mind. It contains everything I need.
It might not fit your needs. That's ok.
But don't expect me to go out of my way implementing your requests.
I'm releasing the software in the hope that it might be helpful to others.

To run it, simply use the following commands:
go build
./writergo

A sample configration can be found at 'config.json'.
To create a new file, simply browse to the future location of the file.
No seperate creation is needed.


You can use one of the provided DataSafes (or write your own) to store data.
Use the "nil" DataSafe to never store any data (or keep DataSafe empty).
Use the "File" DataSafe to store data as files. DataSafeConfig is the target directory.
Use the "MySQL" DataSafe to store data at a MySQL/MariaDB server. DataSafeConfig is the DSN. Use go build -tags="mysql" for building.

WriterGo! is licenced under Apache-2.0.

++++++++++++++++++++++++++++++++++++++++++++
Bundeled libraries
++++++++++++++++++++++++++++++++++++++++++++
WriterGo! is bundeled with the Oxygen font, which is licenced under the SIL Open Font License, Version 1.1.
WriterGo! is bundeled with QuillJS (https://quilljs.com/), which is licenced under the BSD 3-Clause License.
WriterGo! is bundeled with the Quill ImageResize Module (https://github.com/kensnyder/quill-image-resize-module), which is licenced under the MIT License.
WriterGo! is bundeled with highlight.js (https://highlightjs.org/), which is licenced under the BSD 3-Clause License.
WriterGo! is bundeled with the KaTeX (https://katex.org/), which is licenced under the MIT License.
WriterGo! is bundeled with the KaTeX fonts, which are licenced under the SIL Open Font License, Version 1.1.
WriterGo! is bundeled with quill-delta-to-html (https://github.com/nozer/quill-delta-to-html), which are licenced under the MIT License.