Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 1.96 KB

README.md

File metadata and controls

50 lines (38 loc) · 1.96 KB

StoryFontBackendNim

A re-implementation of the storyfont backend in nim. This is a REST-API on top of an sqlite database.

The nim dependencies of this project are:

Beyond that in terms of tooling and software this project uses:

  • Flyway - For database migrations using raw SQL
  • Docker - For containerization with alpine
  • Nginx - As reverse proxy HTTP server
  • Musl - To link the binary against instead of glibc for use with alpine
  • SQLite - The database

Feature Scope

Nimstoryfont is the backend of a CRUD heavy web application, previously called AldruneWiki. It is a wiki capable of hosting dnd campaigns, capable of highly performant processing of requests and pageloads. The corresponding frontend SPA written in Angular is to be found here: https://github.com/PhilippMDoerner/AldruneWikiFrontEnd

Campaigns can be administered by the campaign's individual admin. They can add and remove members as they desire.

It allows writing articles for the following parts of a DnD Campaign:

  • Character
  • Creature
  • Diaryentries (aka Session notes)
  • Items of any importance
  • Locations
  • Organizations and their members
  • Quests
  • Rules
  • Sessions (When they happened, not what happened in them, that is to be recorded in Diaryentries)
  • Spells
  • Quotes

Beyond that notable features include:

  • Displaying (leaflet) maps on which locations can be marked with customizable icons
  • Upload and stream recordings of your sessions, including timestamping them for later use