feat: Add timeline benchmark

This commit is contained in:
Jesse Wierzbinski 2023-11-29 18:16:58 -10:00
parent 15ef1851fc
commit df5e8f744b
No known key found for this signature in database
4 changed files with 74 additions and 1 deletions

View file

@ -23,10 +23,25 @@ This project aims to be a fully featured social network, with a focus on privacy
- [x] Full regex-based filters for posts, users and media
- [x] Custom emoji support
- [x] Automatic image conversion to WebP or other formats
- [x] Scripting-compatible CLI with JSON and CSV outputs
- [ ] Moderation tools
- [ ] Full Mastodon API support
- [ ] Outbound federation
## Benchmarks
> **Note**: These benchmarks are not representative of real-world performance, and are only meant to be used as a rough guide.
### Timeline Benchmarks
You may run the following command to benchmark the `/api/v1/timelines/home` endpoint:
```bash
TOKEN=token_here bun benchmark:timeline <request_count>
```
The `request_count` variable is optional and defaults to 100. `TOKEN` is your personal user token, used to login to the API.
## How do I run it?
### Requirements