social-app README

The project's README from github.com/bluesky-social/social-app. As one markdown file: README.md.

Bluesky Social App

Welcome friends! This is the codebase for the Bluesky Social app.

Get the app itself:

Development Resources

This is a React Native application, written in the TypeScript programming language. It builds on the atproto TypeScript packages (like @atproto/api), which are also open source, but in a different git repository.

There is a small amount of Go language source code (in ./bskyweb/), for a web service that returns the React Native Web application.

The Build Instructions are a good place to get started with the app itself.

The Authenticated Transfer Protocol ("AT Protocol" or "atproto") is a decentralized social media protocol. You don't need to understand AT Protocol to work with this application, but it can help. Learn more at:

The Bluesky Social application encompasses a set of schemas and APIs built in the overall AT Protocol framework. The namespace for these "Lexicons" is app.bsky.*.

Contributions

[!NOTE] While we do accept contributions, we prioritize high quality issues and pull requests. Adhering to the below guidelines will ensure a more timely review.

Rules:

Guidelines:

Remember, we serve a wide community of users. Our day-to-day involves us constantly asking "which top priority is our top priority." If you submit well-written PRs that solve problems concisely, that's an awesome contribution. Otherwise, as much as we'd love to accept your ideas and contributions, we really don't have the bandwidth. That's what forking is for!

Forking guidelines

You have our blessing ๐Ÿช„โœจ to fork this application! However, it's very important to be clear to users when you're giving them a fork.

Please be sure to:

Please read ./ASSETS.md before you ship. Not every file in this repository is covered by our MIT license โ€” some of the artwork, icons, fonts, and brand assets are licensed to us by third parties or are trademarks, and ASSETS.md says which ones and what to do about them. That file is new. Its absence is why some forks have shipped assets they did not have rights to, and that was our omission rather than theirs.

Security disclosures

If you discover any security issues, please send an email to [email protected]. The email is automatically CC'd to the entire team and we'll respond promptly.

Are you a developer interested in building on atproto?

Bluesky is an open social network built on the AT Protocol, a flexible technology that will never lock developers out of the ecosystems that they help build. With atproto, third-party integration can be as seamless as first-party through custom feeds, federated services, clients, and more.

License (MIT)

See ./LICENSE for the full license, which covers the source code in this repository.

It does not cover every file. Certain images, icons, fonts, and brand assets are licensed to us by third parties, or are trademarks, and are carved out โ€” see ./ASSETS.md. Required third-party attribution notices are collected in ./NOTICE.md.

Bluesky Social PBC has committed to a software patent non-aggression pledge. For details see the original announcement.

P.S.

We โค๏ธ you and all of the ways you support us. Thank you for making Bluesky a great place!

social-app (bluesky-social/social-app)

Searching Databaseโ€ฆ

18.3K ยทGitHub
What is this?This is the official codebase for the Bluesky Social app, the client for the decentralized AT Protocol social network, available on Web, iOS, and Android.
Is this a native app or something built on a web framework?It is a React Native application written in TypeScript, with a small Go service (in ./bskyweb/) that serves the React Native Web build.
How do I run this project locally?Follow the project's Build Instructions, then use the Expo scripts: 'pnpm install', then 'expo run:ios', 'expo run:android', or 'expo start --web'.
What does the app build on top of?It relies on the open-source atproto TypeScript packages (like @atproto/api) for the underlying AT Protocol integration, and requires Node.js 24.19+ with pnpm for development.
Can I just fork this and rebrand it as my own app?You can fork it, but you must change all branding, support links, analytics, and replace the landing illustration and UI icons, since those are licensed to Bluesky only and not covered by the MIT license.
Is the whole repo MIT licensed?The source code is MIT licensed, but certain images, icons, fonts, and brand assets are carved out and licensed separately by third parties, as detailed in ASSETS.md.
What is the AT Protocol this app is built on?AT Protocol ('atproto') is a decentralized social media protocol that lets third-party clients, feeds, and federated services integrate as seamlessly as Bluesky's own first-party app.
Do I need to understand AT Protocol to work on this codebase?No, the README states you don't need to understand AT Protocol to work with the application, though it helps and there are guides and specs linked for those who want to dig in.
Size
370.4 MB
Stars
18.3K
Age
4y
Commits ยท 90 Days