Skip to content

Standalone server for GoodMorning Tex (with web pages)

License

Notifications You must be signed in to change notification settings

gmornin/gmt-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

80 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overview

Welcome to GoodMorning Tex - a minimal and easy to use multiformat editor and publishing platform for the web.

You have the freedom to publish your work privately or publicly, written in any format. Browse notes by others or take your own (the "I paid attention in class" flex), it's entirely up to you.

GM Tex is a fresh project in its early development, missing features are expected.

Roadmap

As in early development, here are some of the features which GM Tex currently offers, or are planned to be implemented.

  • Compiling LaTex, Markdown documents.
  • Previewing plain text files, images and documents.
  • Editing files in web editor.
  • Basic file operations. (missing moving/renaming files)
  • Full profile customisations.

  • Publishing documents (cannot directly access items using publish ID, nor is it in web UI)
  • Creating collections from published items.
  • Following users, collections, and get notifications from it.

Goals

The goal is to create a federated publishing service, for learners to read and write notes, and I-want-internet-validation people to publish articles for upvotes.

Hosting

Self hosting a GM Tex instance is very simple.

Requirements:

  • A local MongoDB instance running
  • PDFLatex from TexLive
  • Firejail
  • Basic packages, such as cargo, openssl, etc. (Rust nightly is required).

Run the following commands:

git clone https://github.com/gmornin/gmt-server &&
cd gmt-server &&
cargo install --path . &&
gmt-server

The server should immediately exit with some error messages, this is because the config files are not configured out of the box (to prevent your personal files from getting accessed).

Make sure to go through all config files, you can generate an SSL certificate using certbot.

Congratulations you are now running a GM Tex instance.

About

Standalone server for GoodMorning Tex (with web pages)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published