Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggested changes to readme to make contributing more clear #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Suggested changes to readme to make contributing more clear #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,26 @@ This is a hebrew feed generator for bluesky, based on the [Feed Generator Templa
# Contributing
* Fork the project
* Install dependencies - run `yarn`
* Create a `.env` file with a postgres connection string and your own DID, optionally [more configuration options](https://github.com/AvivRubys/bluesky-hebrew-feed/blob/main/src/config.ts#L9) if you like
* Setup a postgres database on your machine.
* Create a `.env` file with the following variables:
* a postgres connection string
* your own DID, you can find this at https://bsky.social/xrpc/com.atproto.identity.resolveHandle?handle=<your_handle>.bsky.social
entering your account handle in the url
* your own username and password to bluesky
* Subscription endpoint as shown in the example `.env`

optionally [more configuration options](https://github.com/AvivRubys/bluesky-hebrew-feed/blob/main/src/config.ts#L9) if you like.

* Run the server with `yarn dev`, and it will be available on `localhost:3000` (or a different host/port if you changed that configuration)

Example `.env`
```
FEEDGEN_SUBSCRIPTION_ENDPOINT="wss://bsky.network"
POSTGRES_CONNECTION_STRING=postgres://<username>:<password>@<hostname>:<port>/<database_name>?sslmode=disable
FEEDGEN_PUBLISHER_DID=did:plc:abcd...
BLUESKY_CLIENT_LOGIN_IDENTIFIER=username (for bluesky)
BLUESKY_CLIENT_LOGIN_PASSWORD=password (for bluesky)
```
## Debugging
The feeds can be accessed through this url - `http://localhost:3000/xrpc/app.bsky.feed.getFeedSkeleton?feed=at://YOUR_DID_HERE/app.bsky.feed.generator/FEED_NAME` (replace YOUR_DID_HERE with the DID you configured in the .env file, and FEED_NAME with [one of the feed names](https://github.com/AvivRubys/bluesky-hebrew-feed/blob/321caee2b38b2e7cb53a744522d3b4d084d2c807/src/algos.ts#L124-L129))

Expand Down