mirror of
https://git.witchcraft.systems/scientific-witchery/pds-dash.git
synced 2025-06-07 23:44:04 +10:00
59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
# pds-dash
|
|
|
|
a frontend dashboard with stats for your ATProto PDS.
|
|
|
|
## setup
|
|
|
|
### prerequisites
|
|
|
|
- [deno](https://deno.com/manual/getting_started/installation)
|
|
|
|
### installing
|
|
|
|
clone the repo, copy `config.ts.example` to `config.ts` and edit it to your liking.
|
|
|
|
then, install dependencies using deno:
|
|
|
|
```sh
|
|
deno install
|
|
```
|
|
|
|
### development server
|
|
|
|
local develompent server with hot reloading:
|
|
|
|
```sh
|
|
deno task dev
|
|
```
|
|
|
|
### building
|
|
|
|
to build the optimized bundle run:
|
|
|
|
```sh
|
|
deno task build
|
|
```
|
|
|
|
the output will be in the `dist/` directory.
|
|
|
|
## deploying
|
|
|
|
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.
|
|
|
|
## configuring
|
|
|
|
[`config.ts`](config.ts) is the main configuration file, you can find more information in the file itself.
|
|
|
|
## theming
|
|
|
|
themes 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.
|
|
|
|
currently, the name of the theme is determined by the directory name, and the theme itself is defined in `theme.css` inside that directory.
|
|
|
|
you can switch themes by changing the `theme` property in `config.ts`.
|
|
|
|
the favicon is located at [`public/favicon.ico`](public/favicon.ico)
|
|
|
|
## license
|
|
|
|
MIT
|