this repo has no description
witchcraft.systems
1# pds-dash
2
3a frontend dashboard with stats for your ATProto PDS.
4
5## setup
6
7### prerequisites
8
9- [deno](https://deno.com/manual/getting_started/installation)
10
11### installing
12
13clone the repo, copy `config.ts.example` to `config.ts` and edit it to your liking.
14
15then, install dependencies using deno:
16
17```sh
18deno install
19```
20
21### development server
22
23local develompent server with hot reloading:
24
25```sh
26deno task dev
27```
28
29### building
30
31to build the optimized bundle run:
32
33```sh
34deno task build
35```
36
37the output will be in the `dist/` directory.
38
39## deploying
40
41we 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.
42
43## configuring
44
45[`config.ts`](config.ts) is the main configuration file, you can find more information in the file itself.
46
47## theming
48
49the colors are designated in [`src/app.css`](src/app.css) as variables, go crazy with them
50
51the rest is done by editing the css files and style tags directly, good luck
52
53relevant files:
54
55- [`src/App.svelte`](src/App.svelte)
56- [`src/app.css`](src/app.css)
57- [`src/lib/AccountComponent.svelte`](src/lib/AccountComponent.svelte)
58- [`src/lib/PostComponent.svelte`](src/lib/PostComponent.svelte)
59
60the favicon is located at [`public/favicon.ico`](public/favicon.ico)
61
62## license
63
64MIT