AT Protocol "Statusphere" Example App#

An example application covering:

• Signin via OAuth
• Fetch information about users (profiles)
• Listen to the network firehose for new data
• Publish data on the user's account using a custom schema

See https://atproto.com/guides/applications for a guide through the codebase.

Getting Started#

git clone https://github.com/bluesky-social/statusphere-example-app.git
cd statusphere-example-app
cp .env.template .env
npm install
npm run dev
# Navigate to http://localhost:8080

Deploying#

In production, you will need a private key to sign OAuth tokens request. Use the following command to generate a new JWK (JSON Web Key):

./bin/gen-jwk

The generated key must be added to the environment variables (.env file) as PRIVATE_KEY.

PRIVATE_KEYS='[{"kty":"EC","kid":"12",...}]'

Note that you can have multiple keys. Always add new keys at the beginning of the array, so that the first key is always the most recent one. When a key is removed, all associated sessions will be invalidated.

Make sure to also set the COOKIE_SECRET in your environment variables (.env file), which is used to sign session cookies. You can generate a random string for this:

openssl rand -base64 33

Finally, set the PUBLIC_URL to the URL where your app will be accessible. This is used for OAuth client ID and other configurations.

PUBLIC_URL="https://your-app-url.com"