penguinite
/
Forget-Me-Not
forked from ITwrxOrg/Forget-Me-Not
1
0
Fork 0
Code Pull Requests Activity

Update README.md

This commit is contained in:
ITwrx 2025-05-18 10:56:56 -05:00
parent 451492fa20
commit 44410f85f6
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,6 +1,8 @@
#Forget-Me-Not
A single-user-per-instance web application for creating/editing Reminders that can repeat in various ways. Supports email and XMPP notifications. It is written in [Nim](https://nim-lng.org) using the [Guildenstern](https://github.com/olliNiinivaara/GuildenStern) multi-threaded server library and the muti-threaded [SQLiteral](https://github.com/olliNiinivaara/SQLiteral) SQLite API library.
#System Package Dependencies
curl: send any due Reminders by running the following Curl command from /etc/periodic/15min or similar cron mechanism.
-- curl -d "send_reminders_key=your-string-key" -X POST http://127.0.0.1:your-apps-post-port-num/send-reminders
-- set your send_reminders_key in /post_handlers/send_reminders_post_handler.nim
@ -9,10 +11,12 @@ libsodium: This is used to hash user passwords when creating a Forget-Me-Not use
sqlite3: for the database.
nim: to compile binary. We used nim 2.2.4 at the time of writing this.
#Compiling and running
-- Install any non std/lib Nim package dependencies imported in the Forget-Me-Not source code with Nimble.
-- compile with `nim c --cc:clang --mm:atomicArc -d:ssl --d:release fmn_gs.nim`. Remove `--cc:clang` to use gcc instead.
-- automate starting with openrc, systemd, or similar.
-- use nginx (or similar) as reverse proxy and for serving assets.
-- we will try to add some example configs for some of this as time allows, assuming user interest.
#Or use ITwrx web hosted instance.
-- We will add a Forget-Me-Not project page to ITwrx.org along with hosting plan.