ansxor.ca
forked from
jollywhoppers.com/witchsky.app
Bluesky app fork with some witchin' additions 💫
xan.lol
1# Witchsky Social App 🧙 (alpha)
2
3Hey, witches! This is the codebase for the Witchsky app, based on [social.daniela.lol](https://github.com/kittibytess/deer-social) and prior [Bluesky](https://github.com/bluesky-social/social-app) forks.
4
5Get the app itself:
6
7- **Web: [witchsky.app](https://witchsky.app)**
8- **iOS: App Store [Soon™](https://cat-bounce.com/)?**
9- **Android: Play Store Soon! ([F-Droid repo](https://app.jolly.you/fdroid/repo) in the future?)**
10
11<!-- <a href="https://apps.obtainium.imranr.dev/redirect?r=obtainium://add/https://tangled.org/jollywhoppers.com/witchsky.app/">
12<img src="https://github.com/ImranR98/Obtainium/blob/main/assets/graphics/badge_obtainium.png?raw=true"
13alt="Get it on Obtainium" height="54" /></a> -->
14
15## Improvements on Bluesky
16
17- Cooler name (and kawaii logo)
18- Color scheme options and hue slider (defaults to Witchsky orange)
19- You can change "post" to any phrase you want in the UI
20- Choose between sharing witchsky.app or bsky.app links
21- Embed player works with [stream.place](https://stream.place/) links!
22- Open posts in PDSls and original pages of bridged posts
23- You can redraft posts
24- Better defaults (alt text required 😉 autoplay off 🫨)
25- More unique repost icons
26- Can download videos
27- Stay on a page when switching accounts
28- 'Mutuals' in place of 'Following' when relevant
29- No age assurance or blocks based on location
30- No push notifications (hopefully will be added later)
31- Kept as up-to-date as possible (sporadically unstable as a result)
32
33### Experiments
34
35These are all available as options in a sub-page of the app's settings.
36
37- Toggle go.bsky.app link proxying for analytics
38- Toggle to see posts in quotes through blocks and detachments
39- Toggle for buttons to show original fedi posts and in PDSls
40- Toggle to trust your own preferred verifiers (and to operate as one yourself)
41- Toggle to change Constellation instance for custom features
42- Toggle to disable the default app labeler(s)
43
44#### Tweaks
45
46- Toggle to turn non-bsky.social handles into clickable links
47- Toggle to combine reposts in horizontal carousels
48- Toggle the following feed fallback to the discover feed
49- Toggle displaying images in higher quality
50- Toggle to only show a single tab if only one feed is pinned
51- Toggle to prevent others from getting notified when you interact with their reposts
52- Toggle similar account recommendations
53- Toggle to make all user avatars square (like labelers)
54- Toggle for more square-ish UI (still slightly rounded)
55- Toggle to remove the composer prompt at the top of the Following & Discover feeds
56- Change post translation provider (between Google, Kagi, Papago, and LibreTranslate)
57
58#### Metrics
59
60You can completely disable the visiblity of all metrics individually, including the number of:
61
62- likes
63- reposts
64- quotes
65- saves
66- replies
67- followers
68- following
69- & who someone's followed by
70
71## Upcoming or wishful features
72
73- Better OpenGraph support for sharing profiles & posts (including videos & fixing quotes)
74- Selecting a custom AppView
75- Seeing past blocks in threads (the nuclear block in reply chains)
76- Configure the location used to determine regional labelers
77
78### TODO: Xan
79
80- [ ] Setup App Linking for Android (.well-known w/ app package fingerprint)
81- [ ] Fallback/email addresses to use witchsky.social in Automatic PDS detection
82- [ ] Change followed accounts [on onboarding](https://github.com/blacksky-algorithms/blacksky.community/commit/e36ee43efb4999f070860d7f70122e45b28c1e2b)
83- [ ] Join date & switch accounts in composer from a fork like [deer.aylac.top](https://github.com/ayla6/deer-social-test)
84- [ ] Visual replies indicator like the [Firmament userstyle](https://witchsky.app/profile/did:plc:jwhxcrf5uvl3vyw7nurecgt5/post/3m4rr3vzmak2a) (and likes?)
85- [ ] Put DeerSettings into separate subpages
86- [ ] After subpages for options, add [Outlinks page](https://witchsky.app/profile/did:plc:q7suwaz53ztc4mbiqyygbn43/post/3m5zjhhshic2g) &
87 - [ ] ShareMenuItems.tsx, ShareMenuItems.web.tsx
88- [ ] For profile meatball button, Open profile in PDSls & Open bridged OG fedi account page
89 - [ ] ProfileMenu.tsx
90- [ ] Witchsky PDS and .social site (list good songs containing 'bitch' in their titles for related site)
91
92### Even more wishful or far off
93
94- [ ] Collapse labels past a customizable number (from the same labeler?) into a labeler clip "(+)"
95- [ ] Submit releases to the Google Play Store and iOS App Store
96- [ ] Move from [Cloudflare Pages](https://pages.cloudflare.com/) to [wisp.place](https://wisp.place/) (needs serverless for embeds)
97- [ ] Toggle between handle and DID in share links
98- [ ] Move TOS and privacy policy to Jollywhoppers website
99- [ ] Ignore `!no-unauthenticated` labels
100- [ ] Material 3 Expressive theming on Android (Liquid **ass on iOS)
101
102## Development Resources
103
104This is a [React Native](https://reactnative.dev/) application, written in the TypeScript programming language. It builds on the `atproto` TypeScript packages (like [`@atproto/api`](https://www.npmjs.com/package/@atproto/api)), which are also open source, but in [a different git repository](https://github.com/bluesky-social/atproto).
105
106There is vestigial Go language source code (in `./bskyweb/`), for a web service that returns the React Native Web application in the social app deployment. However, it is not used in current Witchsky deployments.
107For Witchsky, the intended deployment is with a webserver that can serve static files, and reroute to `index.html` as needed. [Witchsky](https://witchsky.app) is currently hosted on [Cloudflare Pages](https://pages.cloudflare.com/).
108
109The [Build Instructions](./docs/build.md) are a good place to get started with the app itself. If you use nix (and especially direnv) then `flake.nix` will get you a working environment for the web version of the app.
110
111The 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.
112You may wish to reference [resources linked in social-app](https://github.com/bluesky-social/social-app#development-resources). However, please don't harass the Bluesky team with issues or questions pertaining to Witchsky.
113
114Witchsky is a fork of the official Bluesky client, social-app. It encompasses a set of schemas and APIs built in the overall AT Protocol framework. The namespace for these "Lexicons" is `app.bsky.*`.
115
116## Contributions
117
118> Witchsky is a community fork, and we'd love to merge your PR!
119
120As a rule of thumb, the best features for Witchsky are those that have a disproportionately positive impact on the user experience compared to the maintenance overhead. Unlike some open source projects, since Witchsky is a soft fork, any features (patches) we add on top of upstream social-app need to be maintained. For example, a change to the way posts are composed may be very invasive, touching lots of code across the codebase. If upstream refactors this component, we will need to rewrite this feature to be compatible or drop it from the client.
121
122For this reason, only features that require changing only a small amount of code from upstream should be considered.
123
124Without an overriding motivation, opinionated features should exist behind a toggle that is not enabled by default. This allows Witchsky to cater to as many users as possible.
125
126### Guidelines
127
128- Check for existing issues before filing a new one please.
129- Open an issue and give some time for discussion before submitting a PR.
130 - This isn't strictly necessary, but the lead developers would love to give their thoughts and scope out your willingness to maintain the feature before you write it.
131- Stay away from PRs like...
132 - Changing "Quote" to "Bitch."
133 - Refactoring the codebase, e.g., to replace React Query with Redux Toolkit, etc.
134- Include a new toggle and preference for your feature.
135
136If we don't merge your PR for whatever reason, you are welcome to fork and/or self-host:
137
138## Forking guidelines
139
140Just like social-app, you have our blessing 🪄✨ to fork this application! However, it's very important to make it clear to users when you're giving them a fork.
141
142Please be sure to:
143
144- Change all branding in the repository and UI to clearly differentiate from Witchsky.
145- Change any support links (feedback, email, terms of service, issue tracker, etc) to your own systems.
146
147## Self hosting & personal builds
148
149Self hosting is great! It is our intention that Witchsky is easy to self host and build on your own. If you host your own instance of Witchsky, or make your own builds, please make some level of effort to clarify that it is not an "official" build or instance. This can be in the form of a different domain or branding, but can also be as simple as not advertising your hosted instance or builds as "official" releases.
150
151## Security disclosures
152
153If you discover any security issues, please privately disclose them to [xan.lol](https://xan.lol/).
154If the issue pertains to infastructure, code, or systems outside the scope of Witchsky, please refer to the [disclosure guidelines on social-app](https://github.com/bluesky-social/social-app#security-disclosures) if it is hosted by Bluesky PBC. Otherwise, reference the security policy of that system as applicable <3
155
156## License (MIT)
157
158See [./LICENSE](./LICENSE) for the full license.
159
160Bluesky Social PBC has committed to a software patent non-aggression pledge. For details see [the original announcement](https://bsky.social/about/blog/10-01-2025-patent-pledge).
161
162## P.S.
163
164We ❤️ you and all of the ways you support us. Thank you for making Bluesky & Witchsky so great! ^.^