scientific-witchery/pds-dash
3
0
Fork 0
Code Issues 1 Pull requests 1 Projects 1 Releases Packages Wiki Activity Actions

Config.ts -> config.ts.example

Browse source
This commit is contained in:
Astra 2025-05-15 11:40:39 +09:00
parent 67af67ef49
commit 8eda5e6672
Signed by: astra
SSH key fingerprint: SHA256:jQDNS75/33T59Ey4yAzrUPP/5YQaXEetsW8hwUae+ag
2 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -10,7 +10,9 @@ a frontend dashboard with stats for your ATProto PDS.
### installing
clone the repo, install dependencies using deno:
clone the repo, copy `config.ts.example` to `config.ts` and edit it to your liking.
then, install dependencies using deno:
```sh
deno install

15
config.ts → config.ts.example
View file

@ -3,14 +3,14 @@
*/
export class Config {
/**
* The base URL of the PDS (Personal Data Server)
* @default "https://pds.witchcraft.systems"
* The base URL of the PDS (Personal Data Server).
* @default none
*/
static readonly PDS_URL: string = "https://pds.witchcraft.systems";
static readonly PDS_URL: string = "";
/**
* The base URL of the frontend service for linking to replies/quotes/accounts etc.
* @default "https://deer.social"
* @default "https://deer.social" // or https://bsky.app if you're boring
*/
static readonly FRONTEND_URL: string = "https://deer.social";
@ -24,13 +24,14 @@ export class Config {
static readonly MAX_POSTS: number = 20;
/**
* Footer text for the dashboard, you probably want to change this
* Footer text for the dashboard, you probably want to change this. Supports HTML.
* @default "<a href='https://git.witchcraft.systems/scientific-witchery/pds-dash' target='_blank'>Source</a> (<a href='https://github.com/witchcraft-systems/pds-dash/' target='_blank'>github mirror</a>)"
*/
static readonly FOOTER_TEXT: string =
"Astrally projected from <a href='https://witchcraft.systems' target='_blank'>witchcraft.systems</a><br><br><a href='https://git.witchcraft.systems/scientific-witchery/pds-dash' target='_blank'>Source</a> (<a href='https://github.com/witchcraft-systems/pds-dash/' target='_blank'>github mirror</a>)";
"<a href='https://git.witchcraft.systems/scientific-witchery/pds-dash' target='_blank'>Source</a> (<a href='https://github.com/witchcraft-systems/pds-dash/' target='_blank'>github mirror</a>)";
/**
* Whether to show the posts that are in the future
* Whether to show the posts with timestamps that are in the future.
* @default false
*/
static readonly SHOW_FUTURE_POSTS: boolean = false;