presentation

14 files changed, 102 insertions, 20 deletions

diff --git a/img/collapse.png b/img/collapse.png
new file mode 100644
index 0000000..9c652c9
--- /dev/null
+++ b/img/collapse.png
diff --git a/img/comments.png b/img/comments.png
new file mode 100644
index 0000000..6d1e87b
--- /dev/null
+++ b/img/comments.png
diff --git a/img/gallery.png b/img/gallery.png
new file mode 100644
index 0000000..52841dc
--- /dev/null
+++ b/img/gallery.png
diff --git a/img/home.png b/img/home.png
new file mode 100644
index 0000000..d88c037
--- /dev/null
+++ b/img/home.png
diff --git a/img/invite.png b/img/invite.png
new file mode 100644
index 0000000..c675056
--- /dev/null
+++ b/img/invite.png
diff --git a/img/light.png b/img/light.png
new file mode 100644
index 0000000..77932c9
--- /dev/null
+++ b/img/light.png
diff --git a/img/login.png b/img/login.png
new file mode 100644
index 0000000..3c31351
--- /dev/null
+++ b/img/login.png
diff --git a/img/mobile.png b/img/mobile.png
new file mode 100644
index 0000000..339b93b
--- /dev/null
+++ b/img/mobile.png
diff --git a/img/search.png b/img/search.png
new file mode 100644
index 0000000..347cbb1
--- /dev/null
+++ b/img/search.png
diff --git a/img/subreddit.png b/img/subreddit.png
new file mode 100644
index 0000000..19d7501
--- /dev/null
+++ b/img/subreddit.png
diff --git a/img/subs.png b/img/subs.png
new file mode 100644
index 0000000..9de834d
--- /dev/null
+++ b/img/subs.png
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..24de376
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,102 @@
+### lurker
+
+lurker is a selfhostable, read-only reddit client. it is
+better than old-reddit because:
+
+- it renders well on mobile
+- it respects `prefers-color-scheme`
+- no account necessary to subscribe to subreddits
+- no account necessary for over-18 content
+
+i host a version for myself and a few friends. reach out to
+me if you would like an invite. 
+
+### features
+
+- minimal use of client-side javascript
+- account-based subscription system
+- pagination
+- invite-only user management
+- comment collapsing, jump-to-next/prev comment
+- "search on undelete" url for deleted comments
+- over-18, spoiler images are hidden by default
+
+i use lurker daily, and above features are pretty good for
+my use. i do not intend to add much more, i dont like
+writing js.
+
+### gallery
+
+| ![login](./img/login.png) | ![search](./img/search.png)      | ![subreddit](./img/subreddit.png) |
+| ------------------------- | -------------------------------- | --------------------------------- |
+| login                     | search                           | subreddit view                    |
+
+| ![subs](./img/subs.png)   | ![gallery](./img/gallery.png)    | ![comments](./img/comments.png)   |
+| ------------------------- | -------------------------------- | --------------------------------- |
+| subscriptions page        | inline post thumbnail expand     | comments view                     |
+
+| ![collapse](./img/collapse.png) | ![invite](./img/invite.png)      | ![light](./img/light.png)  | ![mobile](./img/mobile.png) |
+| ------------------------------- | -------------------------------- | -------------------------- | --------------------------- |
+| collapse comments               | admin dashboard & invites table  | light mode                 | mobile optimized page       |
+
+### setup
+
+you can run lurker as a systemd service on nixos:
+
+```
+inputs.lurker.url= "git+https://git.peppe.rs/web/lurker";
+  .
+  .
+  .
+services.lurker = {
+  enable = true;
+  port = 9495;
+};
+```
+
+for non-nixos users:
+
+```
+bun run src/index.js 
+```
+
+### usage
+
+the instance is open to registrations when first started.
+you can head to /register and create an account. this
+account will be an admin account. you can click on your
+username at the top-right to view the dashboard and to
+invite other users to your instance. copy the link and send
+it to your friends!
+
+### technical
+
+lurker uses an sqlite db to store accounts, invites and
+subscriptions. it creates `lurker.db` in the current
+directory. there is no way to configure this right now.
+
+to hack on lurker:
+
+```
+nix shell .#        # get a devshell
+nix build .#lurker  # build the thing
+```
+
+### todo
+
+- [ ] avoid js to toggle details in views/index.pug
+- [ ] highlights for op, sticky etc.
+- [ ] open in reddit/reply in reddit link
+- [ ] subscription manager: reorder, mass add
+- [ ] support crossposts
+- [x] collapse even singular comments
+- [x] details tag on safari
+- [x] expand/collapse comments
+- [x] fix gallery thumbnails
+- [x] fix spacing between comments
+- [x] fix title rendering in views/comments.pug
+- [x] pass query params into templates, add into pagination
+- [x] placeholder for unresolvable thumbnails
+- [x] set home to sum of subs
+- [x] styles for info-containers
+- [x] support 'more comments'
diff --git a/readme.txt b/readme.txt
deleted file mode 100644
index b608336..0000000
--- a/readme.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-nix build .#lurker
-
-todo:
-- [ ] support crossposts
-- [x] fix gallery thumbnails
-- [x] pass query params into templates, add into pagination
-- [ ] subscription manager: reorder, mass add
-- [x] styles for info-containers
-- [ ] open in reddit/reply in reddit link
-- [x] placeholder for unresolvable thumbnails
-- [x] expand/collapse comments
-- [x] fix title rendering in views/comments.pug
-- [x] fix spacing between comments
-- [x] collapse even singular comments
-- [ ] highlights for op, sticky etc.
-- [x] support 'more comments'
-- [ ] avoid js to toggle details in views/index.pug
-- [x] set home to sum of subs
-- [x] details tag on safari
diff --git a/src/routes/index.js b/src/routes/index.js
index d4cfd35..0dafd3e 100644
--- a/src/routes/index.js
+++ b/src/routes/index.js
@@ -1,6 +1,5 @@
 const express = require("express");
 const he = require("he");
-const { hash, compare } = require("bun");
 const jwt = require("jsonwebtoken");
 const geddit = require("../geddit.js");
 const { JWT_KEY } = require("../");