pds dash for shimaenaga.veryroundbird.house (based off of pds.witchcraft.systems)
veryroundbird.house
1# carly's shimaenaga pds version
2
3uhhh the differences here are
4
5* I wrote my own theme CSS. it's one-column and makes the account cards smaller (just avatars)
6* Reorganized CSS
7* Modified markup a bit to use the HTML popover API to show user info cards instead of just linking to the account
8* Added some stuff in the backend code to also pull the user's description and banner to make the account cards fancier
9* Changed font to Recursive Variable (waffling on changing this to space mono though and maybe using recursive just for the profile cards)
10* Replaced favicon
11* Ported in guestbook functionality from another PDS frontpage (see new config options)
12* Secret unique easter egg :)
13* Wrote deploy pipeline for tangled.sh
14
15# original readme below this line
16
17a frontend dashboard with stats for your ATProto PDS.
18
19## setup
20
21### prerequisites
22
23- [deno](https://deno.com/manual/getting_started/installation)
24
25### installing
26
27clone the repo, copy `config.ts.example` to `config.ts` and edit it to your liking.
28
29then, install dependencies using deno:
30
31```sh
32deno install
33```
34
35### development server
36
37local develompent server with hot reloading:
38
39```sh
40deno task dev
41```
42
43### building
44
45to build the optimized bundle run:
46
47```sh
48deno task build
49```
50
51the output will be in the `dist/` directory.
52
53## deploying
54
55we use our own CI/CD workflow at [`.forgejo/workflows/deploy.yaml`](.forgejo/workflows/deploy.yaml), but it boils down to building the project bundle and deploying it to a web server. it'll probably make more sense to host it on the same domain as your PDS, but it doesn't affect anything if you host it somewhere else.
56
57## configuring
58
59[`config.ts`](config.ts) is the main configuration file, you can find more information in the file itself.
60
61## theming
62
63themes are located in the `themes/` directory, you can create your own theme by copying one of the existing themes and modifying it to your liking.
64
65currently, the name of the theme is determined by the directory name, and the theme itself is defined in `theme.css` inside that directory.
66
67you can switch themes by changing the `theme` property in `config.ts`.
68
69the favicon is located at [`public/favicon.ico`](public/favicon.ico)
70
71## license
72
73MIT