baileytownsend.dev
A fork of pds-dash for selfhosted.social
Draft of a proper readme and a license file
astrra.space
+21
LICENSE
+21
LICENSE
···
···
1
+
# MIT License
2
+
3
+
Copyright (c) 2025 Witchcraft Systems
4
+
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights
8
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+
copies of the Software, and to permit persons to whom the Software is
10
+
furnished to do so, subject to the following conditions:
11
+
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
14
+
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
+58
-1
README.md
+58
-1
README.md
···
1
# pds-dash
2
3
+
a 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
+
13
+
clone the repo, install dependencies using deno:
14
+
15
+
```sh
16
+
deno install
17
+
```
18
+
19
+
### development server
20
+
21
+
local develompent server with hot reloading:
22
+
23
+
```sh
24
+
deno task dev
25
+
```
26
+
27
+
### building
28
+
29
+
to build the optimized bundle run:
30
+
31
+
```sh
32
+
deno task build
33
+
```
34
+
35
+
the output will be in the `dist/` directory.
36
+
37
+
## deploying
38
+
39
+
we 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.
40
+
41
+
## configuring
42
+
43
+
`config.ts` is the main configuration file, you can find more information in the file itself.
44
+
45
+
## theming
46
+
47
+
currently the only way to theme the app is to edit css in the components directly, glhf
48
+
49
+
relevant files:
50
+
51
+
- `src/App.svelte`
52
+
- `src/app.css`
53
+
- `src/lib/AccountComponent.svelte`
54
+
- `src/lib/PostComponent.svelte`
55
+
56
+
the favicon is located at `public/favicon.png`
57
+
58
+
## License
59
+
60
+
MIT