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…

这是什么?这是 Bluesky Social 应用的官方代码库。该应用是去中心化社交网络 AT Protocol 的客户端,支持 Web、iOS 和 Android 平台。
这是原生应用,还是基于某个 Web 框架构建的?它是一个用 TypeScript 编写的 React Native 应用,另有一个小型 Go 服务(位于 ./bskyweb/ 目录),用于提供 React Native Web 版本的构建文件。
我该如何在本地运行这个项目?请按照项目的 Build Instructions 操作,然后使用 Expo 脚本:先执行 'pnpm install',再执行 'expo run:ios'、'expo run:android' 或 'expo start --web'。
这个应用基于什么构建?它依赖开源的 atproto TypeScript 包(如 @atproto/api)来实现底层的 AT Protocol 集成,开发时需要 Node.js 24.19+ 和 pnpm。
我能直接 fork 这个项目,把它改成我自己的应用吗?可以 fork,但必须更换所有品牌标识、支持链接和统计分析代码,并替换首页插画和界面图标,因为这些内容仅授权给 Bluesky 使用,不在 MIT 许可证范围内。
整个仓库都是 MIT 许可证吗?源代码采用 MIT 许可证,但部分图片、图标、字体和品牌素材不在其中,由第三方单独授权,详见 ASSETS.md。
这个应用所基于的 AT Protocol 是什么?AT Protocol('atproto')是一种去中心化社交媒体协议,允许第三方客户端、信息流和联邦服务与 Bluesky 自家应用一样无缝集成。
参与这个代码库的开发,需要先了解 AT Protocol 吗?不需要。README 中说明,使用该应用无需了解 AT Protocol,不过了解会有帮助,文档中也附有指南和规范链接,供想深入了解的人查阅。
Size
373.3 MB
Stars
18.3K
Age
4y
Commits · 90 Days