Skip to content

Commit dff3968

Browse files
PhilippMDoernerPhilippMDoerner
PhilippMDoerner
authored andcommitted
Update readme
1 parent f83b933 commit dff3968

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

README.md

+27-26
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,47 @@ This is a REST-API on top of an sqlite database.
55

66
The nim dependencies of this project are:
77

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
1515

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

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
2323

2424
## Feature Scope
2525

2626
Nimstoryfont is the backend of a CRUD heavy web application, previously called AldruneWiki.
2727
It is a wiki capable of hosting dnd campaigns, capable of highly performant processing of requests and pageloads.
2828
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
3030

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

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

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
4646

4747
Beyond that notable features include:
4848

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

Comments
 (0)