whey.party
A collection of Custom Bluesky Feeds, including Fresh Feeds, all under one roof
readme cleanup
+15
-14
README.md
+15
-14
README.md
···
1
# Rinds
2
A collection of feeds under one roof.
3
-
4
-
I don't like Docker and I don't need to compile this, okay thanks!
5
6
## Running
7
-
aint that hard, go install go, setup postgres, and generate the required feed definitions under your user account. you can use https://pdsls.dev to generate a `app.bsky.feed.generator` record.
8
-
Set the `rkey` to the desired short url value. itll look like:
9
```
10
https://bsky.app/profile/{you}/feed/{rkey}
11
```
12
for the contents you can use the example below
13
```
14
{
15
-
"did": "did:web:${INSERT DID:WEB HERE}",
16
"$type": "app.bsky.feed.generator",
17
"createdAt": "2025-01-21T11:33:02.396Z",
18
"description": "wowww very descriptive",
···
20
}
21
```
22
23
## Env
24
You can check out `.env.example` for an example
25
-
26
27
## Postgres
28
Be sure to set up `.env` correctly
···
31
32
## Index
33
You should start Postgres first
34
-
Then go run the firehose ingester in
35
```
36
cd ./indexer
37
```
38
-
and go compile it
39
```
40
go build -o indexer ./indexer.go && export $(grep -v '^#' ./../.env | xargs) && ./indexer
41
```
42
-
after it has been compiled, you can use `rerun.sh` to ensure it will automatically recover after failure
43
44
## Serve
45
Make sure the indexer (or at least Postgres) is running first:
46
```
47
go build -o feedgen cmd/main.go && export $(grep -v '^#' ./.env | xargs) && ./feedgen
48
```
49
-
the logs are pretty verbose imo, fyi
50
51
## Todo
52
- [ ] Faster Indexing
···
67
- [ ] Fresh: Text Only
68
69
## Architecture
70
-
Based on [go-bsky-feed-generator](https://github.com/ericvolp12/go-bsky-feed-generator). Read the README in the linked repo for more info about how it all works.
71
72
-
### /feeds/static
73
Basic example feed from the template. Kept as a sanity check if all else seems to fail.
74
75
-
### /feeds/fresh
76
-
Fresh feeds, all based around a shared Following feed builder and logic to set posts as viewed. May contain some remnant old references to the old name "rinds".
77
···
1
# Rinds
2
A collection of feeds under one roof.
3
+
including Fresh Feeds
4
5
## Running
6
+
Install go, setup postgres, and then generate the required feed definitions under your user account. You can use https://pdsls.dev to generate a `app.bsky.feed.generator` record.
7
+
Set the `rkey` to the desired short url value. Itll look like:
8
```
9
https://bsky.app/profile/{you}/feed/{rkey}
10
```
11
for the contents you can use the example below
12
```
13
{
14
+
"did": "did:web:${your service endpoint}",
15
"$type": "app.bsky.feed.generator",
16
"createdAt": "2025-01-21T11:33:02.396Z",
17
"description": "wowww very descriptive",
···
19
}
20
```
21
22
+
If you are specifically trying to run any of the preexisting feeds, make sure to use the rkey as defined in the /pkg/feeds/*/feed.go and main.go files
23
+
24
## Env
25
You can check out `.env.example` for an example
26
+
The port is for your feedgen serve, not your postgres port
27
28
## Postgres
29
Be sure to set up `.env` correctly
···
32
33
## Index
34
You should start Postgres first
35
+
Then go run the firehose indexder inside
36
```
37
cd ./indexer
38
```
39
+
And then go compile it
40
```
41
go build -o indexer ./indexer.go && export $(grep -v '^#' ./../.env | xargs) && ./indexer
42
```
43
+
Once compiled, you can use `rerun.sh` to ensure it will automatically recover after failure
44
45
## Serve
46
Make sure the indexer (or at least Postgres) is running first:
47
```
48
go build -o feedgen cmd/main.go && export $(grep -v '^#' ./.env | xargs) && ./feedgen
49
```
50
+
Logs are pretty verbose, just FYI.
51
52
## Todo
53
- [ ] Faster Indexing
···
68
- [ ] Fresh: Text Only
69
70
## Architecture
71
+
Based on [go-bsky-feed-generator](https://github.com/ericvolp12/go-bsky-feed-generator). Read the README in the linked repo for more info about how it all works. This repository differs from the template by not using the docker system at all.
72
73
+
### /pkg/feeds/static
74
Basic example feed from the template. Kept as a sanity check if all else seems to fail.
75
76
+
### /pkg/feeds/fresh
77
+
Fresh feeds, all built around a shared Following feed builder and logic to set posts as viewed. May contain some remnant old references to the old name "rinds".
78