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* Add guestbook functionality (see new config options)
12* Wrote deploy pipeline for tangled.sh
13
14# original readme below this line
15
16a frontend dashboard with stats for your ATProto PDS.
17
18## setup
19
20### prerequisites
21
22- [deno](https://deno.com/manual/getting_started/installation)
23
24### installing
25
26clone the repo, copy `config.ts.example` to `config.ts` and edit it to your liking.
27
28then, install dependencies using deno:
29
30```sh
31deno install
32```
33
34### development server
35
36local develompent server with hot reloading:
37
38```sh
39deno task dev
40```
41
42### building
43
44to build the optimized bundle run:
45
46```sh
47deno task build
48```
49
50the output will be in the `dist/` directory.
51
52## deploying
53
54we 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.
55
56## configuring
57
58[`config.ts`](config.ts) is the main configuration file, you can find more information in the file itself.
59
60## theming
61
62themes 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.
63
64currently, the name of the theme is determined by the directory name, and the theme itself is defined in `theme.css` inside that directory.
65
66you can switch themes by changing the `theme` property in `config.ts`.
67
68the favicon is located at [`public/favicon.ico`](public/favicon.ico)
69
70## license
71
72MIT