Draft of a proper readme and a license file
All checks were successful
Deploy / Deploy (push) Successful in 33s

This commit is contained in:
Astra 2025-04-21 15:52:32 +09:00
parent 23cd738d71
commit 8a2ad07d8b
Signed by: astra
SSH key fingerprint: SHA256:jQDNS75/33T59Ey4yAzrUPP/5YQaXEetsW8hwUae+ag
2 changed files with 79 additions and 1 deletions

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
# MIT License
Copyright (c) 2025 Witchcraft Systems
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View file

@ -1,3 +1,60 @@
# pds-dash
Frontend with stats for your ATProto PDS
a frontend dashboard with stats for your ATProto PDS.
## setup
### prerequisites
- [Deno](https://deno.com/manual/getting_started/installation)
### installing
clone the repo, 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` is the main configuration file, you can find more information in the file itself.
## theming
currently the only way to theme the app is to edit css in the components directly, glhf
relevant files:
- `src/App.svelte`
- `src/app.css`
- `src/lib/AccountComponent.svelte`
- `src/lib/PostComponent.svelte`
the favicon is located at `public/favicon.png`
## License
MIT