pyrox.dev / witchsky
forked from jollywhoppers.com/witchsky.app
Bluesky app fork with some witchin' additions 💫
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

Huge README update

xan.lol b3485384 3d6c1d1b

+44 -31
+44 -31
README.md
··· 1 1 # Bitchsky Social App 2 2 3 3 Hey, bitches! This is the codebase for the Bitchsky Social app, based on [social.daniela.lol](https://github.com/kittibytess/deer-social) based on [deer.social](https://github.com/a-viv-a/deer-social). 4 + It's basically Bluesky, but we had an itch for a few more powerful features. 4 5 5 6 Get the app itself: 6 7 ··· 15 16 16 17 - Better name (added an itch; lue no longer) 17 18 - Nicer colors (based on ...) 18 - - Experiments page in settings 19 - - Toggle to disable go.bsky.app link proxying for analytics 20 - - Toggle to disable default app labeler 21 - - Toggle to disable falling back to the discover feed in following feed 22 - - Toggle to see skeets in quotes through blocks and detachments 23 - - <img src="https://github.com/user-attachments/assets/e5084afd-b17e-43a7-9622-f6d7f19f53ca" width="300px" /> 24 - - Checkboxes to enable features gates 25 19 - Ignores `!no-unauthenticated` labels 26 20 - Share links to bitchsky.app or bsky.app 27 21 28 - ## WIP/Planned 22 + ### Experiments 23 + 24 + These are all available as options in a subpage of the app's settings. 25 + 26 + - Toggle go.bsky.app link proxying for analytics 27 + - Toggle to see skeets in quotes through blocks and detachments 28 + - <img src="https://github.com/user-attachments/assets/e5084afd-b17e-43a7-9622-f6d7f19f53ca" width="300px" alt="example quote post removed by author, but still shown" /> 29 + - Toggle to trust your own preferred verifiers (and to operate as one yourself) 30 + - Toggle to disable the default app labeler 31 + 32 + #### Tweaks 33 + 34 + - Toggle to combine reposts in horizontal carousels 35 + - Toggle the discover feed fallback in the following feed 36 + - Toggle to allow visiting sites from clicking non-bsky.social handles 37 + - Toggle displaying images in higher quality 38 + - Toggle to only show a single tab if only one feed is pinned 39 + - Toggle to prevent others from getting notified that you interacted with their repost 40 + - Toggle similar account recommendations 41 + 42 + #### Metrics 43 + 44 + You can disable the visiblity of all skeet metrics individually, including the likes, reposts, quotes, saves, and reply counts. 45 + 46 + #### Gates 47 + 48 + - Toggle for an alternate share icon 49 + - A couple others 50 + - More may be available in developer mode 51 + 52 + ## Upcoming or wishful features 29 53 30 - - Opengraph support for sharing skeets and profiles 31 - - Selecting custom appviews 32 - - Seeing past blocks in post threads (nuclear block for reply chains) 54 + - OpenGraph support for sharing profiles & skeets 55 + - Selecting a custom AppView 56 + - Seeing past blocks in threads (the nuclear block for reply chains) 33 57 - Configure the location used to determine regional labelers 34 - 35 58 36 59 ### TODO: Xan 37 60 38 61 - [ ] Update branding (especially colors and app icon) to Bitchsky 39 62 - [ ] Setup App Linking for Android (.well-known w/ app package fingerprint) 63 + - [ ] Remove broken Experiments (constellation instance and TODO note) 40 64 - [ ] Replace instances of `group.app.bsky` with `group.app.bitchsky` 41 65 - [ ] Add a toggle to replace "New Post" with "Skeet" (and other instances of "Post" in English) 42 66 - [ ] [Coffee](https://git.ari.lt/coffee) for colors in actual themes 67 + - [ ] Bitchsky PDS and .social site 43 68 44 - #### Maybe 69 + ### Even more wishful or far off 45 70 46 71 - [ ] iOS app IPA? 47 72 - [ ] Move from GitHub to Tangled? 48 - 49 - ## Philosophy 50 - 51 - - by default, Bitchsky should very similar to the official client 52 - - color and branding are different to distinguish from social-app 53 - - `!no-unauthenticated` behavior is different 54 - - analytics are not present 55 - - opinionated features behind toggles 56 - - focus on high impact, low diff size patches 57 - - specifically patches that won't require large conflicts to be resolved 58 - - focus on power users (but all users are welome!) 59 - - enable things that are possible but annoying today **without** egging on anti-social behavior 73 + - [ ] Experimental toggle between handle and DID in share links? 74 + - [ ] Move TOS and privacy policy to Jollywhoppers? 60 75 61 76 ## Development Resources 62 77 63 78 This 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). 64 79 65 80 There 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 Bitchsky deployments. 66 - For Bitchsky, the intended deployment is with a webserver that can serve static files, and reroute to `index.html` as needed. Today [Bitchsky](https://bitchsky.app) is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). 81 + For Bitchsky, the intended deployment is with a webserver that can serve static files, and reroute to `index.html` as needed. [Bitchsky](https://bitchsky.app) is currently hosted on [Cloudflare Pages](https://pages.cloudflare.com/). 67 82 68 83 The [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. 69 84 ··· 88 103 - Open an issue and give some time for discussion before submitting a PR. 89 104 - This isn't strictly necessary, but I'd love to give my thoughts and scope out your willingness to maintain the feature before you write it. 90 105 - Stay away from PRs like... 91 - - Changing "Post" to "Skeet." 106 + - Changing "Post" to "Skeet." 🧌 92 107 - Refactoring the codebase, e.g., to replace React Query with Redux Toolkit or something. 93 108 - Include a new toggle and preference for your feature. 94 109 ··· 110 125 ## Security disclosures 111 126 112 127 If you discover any security issues, please privately disclose them to [xan.lol](https://xan.lol/). 113 - If the issue pertains to infastructure, code, or systems outside the scope of Bitchsky, please refer to the 114 - [disclosure guidelines on social-app](https://github.com/bluesky-social/social-app#security-disclosures) if it is hosted by Bluesky PBC. Otherwise, reference the 115 - security policy of that system as applicable <3 128 + If the issue pertains to infastructure, code, or systems outside the scope of Bitchsky, 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 116 129 117 130 ## License (MIT) 118 131 ··· 122 135 123 136 ## P.S. 124 137 125 - We ❤️ you and all of the ways you support us. Thank you for making Bluesky & Bitchsky a great place! 138 + We ❤️ you and all of the ways you support us. Thank you for making Bluesky & Bitchsky so great!