From ceae744601ac9e49f7c2e7b1d9280bb511c09386 Mon Sep 17 00:00:00 2001 From: Alice <81575558+aliceisjustplaying@users.noreply.github.com> Date: Fri, 12 May 2023 04:28:27 +0100 Subject: [PATCH] Update README with instructions for the default URL (#11) * update README with instructions for the default URL * Update README.md --------- Co-authored-by: Daniel Holmgren --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5cc7a83..cf707a6 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,10 @@ We've taken care of setting this server up with a did:web. However, you're free Once the custom algorithms feature launches, you'll be able to publish your feed in-app by providing the DID of your service. +## Running the Server + +Install dependencies with `yarn` and then run the server with `yarn start`. This will start the server on port 3000, or what's defined in `.env`. You can then watch the firehose output in the console and access the output of the default custom ALF feed at [http://localhost:3000/xrpc/app.bsky.feed.getFeedSkeleton?feed=did:example:alice/app.bsky.feed.generator/whats-alf](http://localhost:3000/xrpc/app.bsky.feed.getFeedSkeleton?feed=did:example:alice/app.bsky.feed.generator/whats-alf). + ## Some Details ### Skeleton Metadata