53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
# `nederlandskie`
|
|
|
|
A Bluesky feed generator written in Rust.
|
|
|
|
The specific algorithm indexes and serves posts written in Russian language, by people living in Netherlands.
|
|
|
|
Not fully complete yet, see roadmap.
|
|
|
|
## Roadmap
|
|
|
|
- [x] Read stream of posts from Bluesky
|
|
- [x] Store posts in the database
|
|
- [x] Store user profiles in the database
|
|
- [x] Detect the country of residence from profile information
|
|
- [x] Keep subscription state to not lose messages
|
|
- [x] Serve the feed
|
|
- [x] Handle deleting of posts
|
|
- [x] Handle errors in the web service gracefully
|
|
- [x] Handle missing profiles in the profile classifier
|
|
- [x] Add a way to mark a profile as being from a certain country manually
|
|
- [x] Handle reconnecting to websocket somehow
|
|
- [x] Publish the feed
|
|
|
|
## Configuration
|
|
|
|
1. Copy `.env.example` into `.env` and set up the environment variables within:
|
|
|
|
- `PUBLISHER_BLUESKY_HANDLE` to your Bluesky handle
|
|
- `PUBLISHER_BLUESKY_PASSWORD` to Bluesky app password that you created in settings
|
|
- `CHAT_GPT_API_KEY` for your ChatGPT key
|
|
- `DATABASE_URL` for PostgreSQL credentials
|
|
- `FEED_GENERATOR_HOSTNAME` to the hostname of where you intend to host the feed
|
|
|
|
2. Determine your own DID and put it in `PUBLISHER_DID` env variable in `.env`:
|
|
|
|
```
|
|
cargo run --bin who_am_i
|
|
```
|
|
|
|
## Running
|
|
|
|
### Populate and serve the feed
|
|
|
|
`cargo run`
|
|
|
|
### Determine your own did for publishing
|
|
|
|
`cargo run --bin who_am_i`
|
|
|
|
### Publish the feed
|
|
|
|
`cargo run --bin publish_feed -- --help`
|