@@ -5,46 +5,47 @@ This is a REST-API on top of an sqlite database.
5
5
6
6
The nim dependencies of this project are:
7
7
8
- - Application Server: prologue - https://github.com/planety/prologue
9
- - ORM + connection pooling: norm - https://github.com/moigagoo/norm
10
- - (De)Serializing JSON to/from ORM models: jsony - https://github.com/treeform/jsony
11
- - Simplifaction of model-object construction: constructor - https://github.com/beef331/constructor
12
- - Compressing HTTP Responses: zippy - https://github.com/guzba/zippy
13
- - Password Hashing: Nimword - https://github.com/PhilippMDoerner/nimword
14
- - Sending emails: smtp - https://github.com/nim-lang/smtp
8
+ - Application Server: prologue - https://github.com/planety/prologue
9
+ - ORM + connection pooling: norm - https://github.com/moigagoo/norm
10
+ - (De)Serializing JSON to/from ORM models: jsony - https://github.com/treeform/jsony
11
+ - Simplifaction of model-object construction: constructor - https://github.com/beef331/constructor
12
+ - Compressing HTTP Responses: zippy - https://github.com/guzba/zippy
13
+ - Password Hashing: Nimword - https://github.com/PhilippMDoerner/nimword
14
+ - Sending emails: smtp - https://github.com/nim-lang/smtp
15
15
16
16
Beyond that in terms of tooling and software this project uses:
17
17
18
- - Flyway - For database migrations using raw SQL
19
- - Docker - For containerization with alpine
20
- - Nginx - As reverse proxy HTTP server
21
- - Musl - To link the binary against instead of glibc for use with alpine
22
- - SQLite - The database
18
+ - Flyway - For database migrations using raw SQL
19
+ - Docker - For containerization with alpine
20
+ - Nginx - As reverse proxy HTTP server
21
+ - Musl - To link the binary against instead of glibc for use with alpine
22
+ - SQLite - The database
23
23
24
24
## Feature Scope
25
25
26
26
Nimstoryfont is the backend of a CRUD heavy web application, previously called AldruneWiki.
27
27
It is a wiki capable of hosting dnd campaigns, capable of highly performant processing of requests and pageloads.
28
28
The corresponding frontend SPA written in Angular is to be found
29
- here: https://github.com/PhilippMDoerner/AldruneWikiFrontEnd
29
+ here: https://github.com/PhilippMDoerner/nimstoryfont-gui
30
30
31
31
Campaigns can be administered by the campaign's individual admin. They can add and remove members as they desire.
32
32
33
33
It allows writing articles for the following parts of a DnD Campaign:
34
34
35
- - Character
36
- - Creature
37
- - Diaryentries (aka Session notes)
38
- - Items of any importance
39
- - Locations
40
- - Organizations and their members
41
- - Quests
42
- - Rules
43
- - Sessions (When they happened, not what happened in them, that is to be recorded in Diaryentries)
44
- - Spells
45
- - Quotes
35
+ - Character
36
+ - Creature
37
+ - Diaryentries (aka Session notes)
38
+ - Items of any importance
39
+ - Locations
40
+ - Organizations and their members
41
+ - Quests
42
+ - Rules
43
+ - Sessions (When they happened, not what happened in them, that is to be recorded in Diaryentries)
44
+ - Spells
45
+ - Quotes
46
46
47
47
Beyond that notable features include:
48
48
49
- - Displaying (leaflet) maps on which locations can be marked with customizable icons
50
- - Upload and stream recordings of your sessions, including timestamping them for later use
49
+ - Displaying (leaflet) maps on which locations can be marked with customizable icons
50
+ - Upload and stream recordings of your sessions, including timestamping them for later use
51
+ - Creating data-dumps for individual campaigns to download, enabling offline-browsing of campaign data. This is done via the dataExportJob file
0 commit comments